Inhaltsverzeichnis
Was ist eine programmdokumentation?
Mit Softwaredokumentation bezeichnet man die Dokumentation von Software. Sie erklärt für Entwickler, Anwender (Auftraggeber, Kunde) und Endbenutzer in unterschiedlichen Rollen, wie die Software funktioniert, was sie erzeugt und verarbeitet (z.
Was ist eine entwicklerdokumentation?
Entwicklerdokumentation wird für verschiedene Gegenstände der Softwareentwicklung angefertigt. Dazu zählen beispielsweise Anforderungen, Architekturen, Quellcode, Schnittstellen, Modelle und Testfälle.
Was ist Quellcode Dokumentation?
Dokumentation des Quellcodes wird im Quellcode gemacht. Das bedeutet, dass der Entwickler sich keine Gedanken um das Dokumentationswerkzeug machen muss – er benutzt die selben Instrumente wie bei der Softwareentwicklung.
Was sind generelle Dokumentationstypen?
Es existieren zwei generelle Dokumentationstypen: Zum einen gibt es bestimmte Vorschriften (Anweisungen, Anforderungen) und zum anderen Protokolle oder Berichte. Eine gute Dokumentationspraxis sollte dem jeweiligen Dokumentationstyp entsprechend angepasst sein.
Was ist ein Dokumentationssystem?
Dokumentationssystem. Ein Dokumentationssystem ist ein System oder Verfahren, das ein leichtes Wiederauffinden von Dokumenten ermöglicht. Die Dokumente werden dazu archiviert und dokumentiert. Dies geschieht inzwischen fast immer mit Hilfe von Datenbanken . Die Bandbreite von Dokumentationssystemen reicht von einfachen Katalogen bis hin…
Welche Bestandteile eines Dokumentationssystems lassen sich ausmachen?
Es lassen sich 5 Bestandteile eines jeden Dokumentationssystems ausmachen: Zur Erschließung der Dokumente werden diese mit Metadaten versehen. Die Metadaten-arten und -ausprägungen sind durch das Ordnungssystem gegeben.
Welche Form der Dokumentation kann jeder Entwickler durchführen?
Die grundlegendste Form der Dokumentation, die jeder Entwickler durchführen kann, ist die Programmierdokumentation. Während der Entwicklung werden Kommentare im Quellcode eingefügt, die die einzelnen Schritte kurz erklären.