Ich habe gerade ein relativ kleines Projekt abgeschlossen (ca. 3000 Zeilen Code in mehreren Modulen) 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.
Sie sollten mindestens dokumentieren
Je nachdem, wie die Software verwendet wird, möchten Sie vielleicht
Sie könnten viel schlechter arbeiten als die DOD-STD-2178A-Datenelementbeschreibungen für das Software-Design-Dokument und das Versionsbeschreibungsdokument.
Das SDD beschreibt das Design der Software. Der VDD beschreibt die Verpackung, einschließlich der Installation (entpacken, kompilieren, laden, einrichten).
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 kann besser für zukünftige Projekte ausgegeben werden.