Wie schreibe ich Projektdokumentation?

Question

Ich habe gerade ein relativ kleines Projekt (~ 3000 Zeilen Code in mehreren Modulen) abgeschlossen und ich wurde gebeten, ein Dokument für das Projekt zu erstellen. Ich habe keine Ahnung, wie ich das machen soll, da ich vorher Code für andere Programmierer geschrieben habe. Beschreibe ich jedes Modul, mache UML-Diagramme für jedes Objekt, erweitere einfach meine Kommentare? Gibt es eine Vorlage, die ich dafür verwenden kann? Wenn jemand Standarddokumentationen machen musste, würde ich mich über Ihre Hilfe/Hinweise freuen.

Answer 1

Es gibt nicht viel "Standard" -Dokumentation; "Javadoc" -artige API-Dokumente sind ungefähr so ​​nah wie du kommst. Erhalten Sie mehr solide Anforderungen. Welche Art von Dokumenten benötigt Ihr Kunde? UML-Diagramme für alle Ihre Klassen sind eine nette Übung und manchmal nützlich, aber Ihre Zeit ist vielleicht besser für zukünftige Projekte.

Answer 2

Zumindest sollten Sie dokumentieren

• , wie die Software
• zu bauen, wie es ein "Manifest" von Dateien und Tools
• Release Notes erforderlich
• zu installieren: was sich aus der veränderten vorherige veröffentlichte Version
• Lizenz- und Copyrightinformationen

Dann, je nachdem, wie die Software verwendet wird, möchten Sie vielleicht

• Benutzerhandbuch
• API-Dokumentation

Answer 3

Sie könnten die DOD-STD-2178A Daten Element Beschreibungen viel schlechter machen als die Überprüfung für das Software-Design-Dokument und das Versionsbeschreibungsdokument.

Der SDD beschreibt das Design der Software. Der VDD beschreibt die Verpackung, einschließlich der Installation (Entpacken, Kompilieren, Laden, Einrichten).