4 Stimmen

Dokumentieren einer Access-Anwendung für Entwickler

Ich muss eine MS-Access-Anwendung dokumentieren, die von einem Power-User über 10 Jahre hinweg vollständig erstellt, entwickelt und gepflegt wurde.

Dies ist eine interessante Situation, denn sie wollen ein Handbuch, damit ein zukünftiger Entwickler ohne vorherige Fachkenntnisse Änderungen am Frontend oder Backend zeitnah vornehmen kann.

Bei diesem kleinen Projekt stellen sich mir einige Fragen:

  • Was ist eine gute Anwendung zur manuellen Designerstellung? Microsoft Word reicht da nicht ganz aus.
  • Welche Dinge müssen Sie als Entwickler wissen, um Änderungen an Formularen, Berichten, Tabellen oder anderen Access-Objekten vornehmen zu können?
  • Habe ich sonst noch etwas übersehen? Irgendwelche Fallstricke?

3 Stimmen

Ich würde sagen, dass ich als Entwickler eine gute Kommentierung des Codes, einheitliche Namenskonventionen und ein gutes Design einem Dokument vorziehe, das ich wahrscheinlich nie lesen werde. Wenn Sie sagen "ohne vorheriges Fachwissen", dann ist nicht klar, ob Sie Access oder die spezifische Anwendung meinen. Falls ersteres, viel Glück damit - Sie könnten ein Buch schreiben. Falls letzteres, siehe meinen ersten Kommentar!

0 Stimmen

Ich meine die Art und Weise, wie das Unternehmen als Quelle für das "Fachwissen" arbeitet. Es gibt eine lot Ich habe ein paar Wochen damit verbracht, mehr über die Eigenheiten, unerwarteten Geschäftsregeln und andere Verhaltensweisen zu erfahren, die für die Einrichtung der Datenbank und die Funktionsweise der Anwendung als Ganzes äußerst wichtig sind.

2 Stimmen

Das Problem ist, dass diese Art von Dokumenten nur selten aktualisiert wird, wenn sie einmal fertig sind. Vielleicht wäre die Idee eines Wikis, das von den Benutzern erstellt wird, eine gute Idee. Und die Idee ist, dass jeder neue Benutzer immer ihre Frage(n) in das Wiki stellen und dann die Antworten abrufen und sie aktualisieren. Und man muss ihnen die Zeit geben, dies zu tun. Warum nicht auch innerhalb der Access-Anwendung. Erstellen Sie eine Tabelle mit einem Feld für den Formularnamen und einem weiteren Memofeld. Jedes Formular erhält eine Schaltfläche, die ein Formular in dieser Tabelle öffnet und den Datensatz für dieses Formular erstellt/aktualisiert. Dann können die Benutzer das Memo-Feld direkt dort aktualisieren.

3voto

Philippe Grondier Punkte 10636

Sie könnten damit beginnen, eine automatische Code-Dokumentation mit dem MZ-Tools Add-in für VBA zu erstellen. Dasselbe Add-in kann Ihnen dabei helfen, nicht verwendete Variablendeklarationen zu bereinigen, Zeilennummern zu generieren, Prozeduren innerhalb eines Moduls neu zu ordnen usw.

Die Dokumentation von Formularen ist schwieriger. Mein Vorschlag wäre, einen Screenshot zusammen mit einer .txt-Datei aufzubewahren, die mit der undokumentierten Methode application.saveAstext erstellt wird.

2voto

Uri Punkte 86472

Meiner Erfahrung nach sind Access- und VB6-basierte Programme von mehr Code-Replikation und technischen Schulden geplagt als Programme in Mainstream-Sprachen. Ich bin mir nicht sicher, warum. Vielleicht liegt es an der Natur von Access als "Prototyp"- oder "Spielzeug"-Datenbank (obwohl sie ziemlich leistungsfähig sein kann, wenn man sie richtig einsetzt).

Wenn ich die Wahl hätte zwischen dem Zeitaufwand für die Dokumentation und dem Zeitaufwand für die Reduzierung der technischen Schulden, z. B. durch Remodularisierung, Beseitigung von wiederholtem Code, Aufteilung langer Funktionen usw., würde ich mich für Letzteres entscheiden. Die Verbesserung der Wartbarkeit und Lesbarkeit wäre größer.

1voto

iDevlop Punkte 24046

Ich weiß, dass diese Seite schon lange geschlossen ist, aber ich kann es mir nicht verkneifen, meine 2 Cents hinzuzufügen:
In dem erwähnten Fall denke ich, dass die nützlichste zu erstellende Dokumentation eine FUNKTIONSDOKUMENTATION ist (die in einer idealen Welt schon vor Beginn der Entwicklung hätte existieren sollen).
Die zweite ist im Code selbst, und dazu gehören die VBA, aber auch die Feldbeschreibungen, die in Access und SQL Server eingestellt werden können.
Drittens ein (oder eine Reihe von) schönen Datenbankdiagrammen. Sobald Sie das haben, kann der neue Entwickler alles andere mit SEINEN bevorzugten Werkzeugen erstellen.
Apropos Tools, die ich besonders mag und empfehle:

  • MZ Tools: speziell um leicht herauszufinden, welche Routinen die von Ihnen betrachtete Routine aufrufen
  • Smart Indent: um Code richtig einzurücken. Beim Versuch, schlecht eingerückten Code zu lesen, wird mir schlecht
  • SqlSpec: (nicht kostenlos) generiert HTML-Dokumente der Datenbank selbst für die meisten Datenbank-Engines

0voto

Albert D. Kallal Punkte 30379

Haben Sie versucht, den eingebauten Datenbank-Documenter zu verwenden? Er druckt alle Tabellen, Indizes, Formulare, Steuerelemente und jede Eigenschaft der Steuerelemente aus. Code, die verwendete Sql und so ziemlich alles andere. Das Ergebnis sind riesige, aber eben riesige Ausdrucke. Auch wenn dabei ein paar Bäume gefällt werden, so ist es doch eine gute Möglichkeit, den Chef zu beeindrucken.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X