Programmdokumentation
Alle geschriebenen Texte, Abbildungen oder Videos, die den Benutzern eine Software oder ein Programm beschreiben, werden aufgerufen program or software document. Der Benutzer kann jeder sein, vom Programmierer, Systemanalysten und Administrator bis zum Endbenutzer. In verschiedenen Entwicklungsstadien können mehrere Dokumente für verschiedene Benutzer erstellt werden. Eigentlich,software documentation ist ein kritischer Prozess im gesamten Softwareentwicklungsprozess.
In der modularen Programmierung wird die Dokumentation noch wichtiger, da verschiedene Module der Software von verschiedenen Teams entwickelt werden. Wenn jemand anderes als das Entwicklungsteam ein Modul verstehen möchte oder muss, erleichtert eine gute und detaillierte Dokumentation die Aufgabe.
Dies sind einige Richtlinien zum Erstellen der Dokumente -
Die Dokumentation sollte aus Sicht des Lesers erfolgen
Das Dokument sollte eindeutig sein
Es sollte keine Wiederholung geben
Industriestandards sollten verwendet werden
Dokumente sollten immer aktualisiert werden
Veraltete Dokumente sollten nach ordnungsgemäßer Aufzeichnung des Ausstiegs auslaufen
Vorteile der Dokumentation
Dies sind einige der Vorteile der Bereitstellung von Programmdokumentation -
Verfolgt alle Teile einer Software oder eines Programms
Wartung ist einfacher
Andere Programmierer als der Entwickler können alle Aspekte der Software verstehen
Verbessert die Gesamtqualität der Software
Hilft bei der Benutzerschulung
Gewährleistet die Dezentralisierung des Wissens und senkt Kosten und Aufwand, wenn Benutzer das System abrupt verlassen
Beispieldokumente
Einer Software können viele Arten von Dokumenten zugeordnet sein. Einige der wichtigsten sind -
User manual - Es beschreibt Anweisungen und Verfahren für Endbenutzer, um die verschiedenen Funktionen der Software zu verwenden.
Operational manual - Es listet und beschreibt alle ausgeführten Operationen und ihre gegenseitigen Abhängigkeiten.
Design Document- Es gibt einen Überblick über die Software und beschreibt Designelemente im Detail. Es dokumentiert Details wiedata flow diagrams, entity relationship diagrams, usw.
Requirements Document- Es enthält eine Liste aller Anforderungen des Systems sowie eine Analyse der Lebensfähigkeit der Anforderungen. Es kann Benutzerfälle, reale Szenarien usw. enthalten.
Technical Documentation - Es handelt sich um eine Dokumentation der tatsächlichen Programmierkomponenten wie Algorithmen, Flussdiagramme, Programmcodes, Funktionsmodule usw.
Testing Document - Es zeichnet Testplan, Testfälle, Validierungsplan, Verifizierungsplan, Testergebnisse usw. auf. Das Testen ist eine Phase der Softwareentwicklung, die eine intensive Dokumentation erfordert.
List of Known Bugs- Jede Software weist Fehler auf, die nicht behoben werden können, da sie entweder sehr spät entdeckt wurden oder harmlos sind oder mehr Aufwand und Zeit als nötig erfordern, um sie zu beheben. Diese Fehler werden in der Programmdokumentation aufgeführt, damit sie zu einem späteren Zeitpunkt behoben werden können. Außerdem helfen sie den Benutzern, Implementierern und Wartungsmitarbeitern, wenn der Fehler aktiviert ist.