Dokumentieren einer Access-Anwendung für Entwickler [geschlossen]

Question

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

Dies ist eine interessante Situation, weil, was sie wollen eine manuelles so ist, dass ein zukünftiger Entwickler vor Domänenwissen und Make kommen kann Änderungen an den Frontend oder Backend in zeitnah ohne.

Es gibt ein paar Fragen in meinem Kopf für dieses kleine Projekt:

• Was ist eine gute Hand-Design zu schaffen Anwendung? Microsoft Word nicht ganz schneiden Sie es.
• Welche Dinge würden Sie, der Entwickler, müssen wissen, um Änderungen an Dinge wie Formulare, Berichte, Tabellen oder andere Access-Objekte zu machen?
• Alles andere habe ich verpasst? Fallstricke?

Answer 1

Nach meiner Erfahrung, Access und VB6- basierte Programme werden von mehr Code-Replikation und technischen Schulden als Programme in der Mainstream-Sprachen geplagt. Ich bin mir nicht sicher warum. Vielleicht ist es die Art von Access als „Prototyp“ oder „Spielzeug“ Datenbank (obwohl es sehr mächtig sein kann, wenn ergibt richtig).

Wenn ich zwischen aufwendet Zeit auf Dokumentation zu wählen habe und Zeit aufwendet auf technischen Schuldenabbau, zum Beispiel durch remodularizing, wiederholten Code beseitigen, Splitting lange Funktionen usw., würde ich die zweite Möglichkeit entscheiden. Die Verbesserung Wartbarkeit und Lesbarkeit größer wäre.

Answer 2

mit MZ-Werkzeugen Add-in für VBA

Sie könnten mit der Erzeugung einig automatische Code-Dokumentation starten. Das gleiche Add-In kann Ihnen helfen, sauber ungebraucht Variablendeklarationen, erzeugen Zeilennummern, Neuordnungsverfahren innerhalb eines Moduls, etc.

Formen Dokumentieren ist schwieriger. Mein Vorschlag wäre, einen Screenshot zu halten, ALLtogether mit einer .txt-Datei über die undokumentierte application.saveAstext Verfahren erhalten.

Answer 3

Ich weiß, dass dies für lange geschlossen ist, aber ich kann meinen Zugabe von 2 Cent nicht verzichten:
In dem Fall erwähnt, ich denke, die am nützlichsten doc, um eine FUNKTIONS Dokumentation ist (die die Entwicklung in einer idealen vor dem Start Welt existiert haben sollen).
Zweitens ist im Code selbst, und das schließt die VBA, sondern auch die Feldbeschreibungen, die in Access und SQL Server eingestellt werden können.
Drittens ist eine (oder eine Reihe von) nice Datenbank-Diagramm. Sobald Sie das haben, alle der Rest kann durch den neuen Entwickler erzeugt werden seine Lieblingstools.
Sprechen über Werkzeuge, besonders gefällt mir und empfehlen:

• MZ Werkzeuge: besonders leicht zu finden, welche Routinen derjenige Ihr Anruf bei der Suche
• Smart einrücken: richtig Einzug Code. Der Versuch, schlecht eingerückt Code zu lesen macht mich krank
• SqlSpec: (nicht kostenlos) erzeugt HTML-doc der Datenbank selbst für die meisten Datenbank-Engines

Answer 4

Haben Sie versucht, die die Verwendung in der Datenbank documenter gebaut? Es wird auszudrucken alle Tabellen, Indizes, Formulare, Kontrollen, jede Eigenschaft der Kontrollen. Code verwendete SQL und nur über irgend etwas anderes. Dies führt zu großen, aber nur massiven Ausdrucken. Doch während es ein paar Bäume in dem Prozess töten wird es sicher eine gute Möglichkeit, den Chef zu beeindrucken.