Logo der Physikalisch-Technischen Bundesanstalt
Symbolbild: "Wissenschaftlich-technische Publikationen"

PTB-Berichte Informationstechnik (IT)

Publikations Einzelansicht

PTB-IT-14

Richtlinie für die Softwaredokumentation = Guideline for software documentation

Autor(en): Norbert Greif und Doris Saborrosch
Herausgeber: Physikalisch-Technische Bundesanstalt
Report Typ: PTB-Report
Jahr: 2006
Seite(n): 111 S., 44 Abb., 20 Tab.
Verschiedenes: € 17,50
ISBN: ISBN 3-86509-550-X ; ISSN 0942-1785
Zusammenfassung: Obwohl Computerprogramme und die zugehörige Dokumentation untrennbare Softwarebestandteile sind, wird die Dokumentation im Softwareentwicklungsprozess häufig vernachlässigt. In vielen Fällen fehlt sie vollkommen. Dabei ist eine vollständige, übersichtlich gegliederte, für den jeweiligen Benutzerkreis verständliche und mit der Funktionalität des Programms übereinstimmende Dokumentation. eine Grundvoraussetzung für die reibungslose Anwendung und Pflege (Änderung, Erweiterung) von Software. Um Dokumentationsmängel und ihre Folgen zu vermeiden, ist es notwendig, die Ziele und die Funktion der Softwaredokumentation herauszustellen und dies in eine entsprechende Richtlinie umzusetzen. Eine Dokumentationsrichtlinie ermöglicht durch die einheitliche Vorgabe von Gliederungen und eine einheitliche Begriffsverwendung die Vollständigkeit und Vergleichbarkeit der Dokumentation.


Although computer programs and the associated documentation are inseparable parts of the software, the documentation is often neglected in software development and in many cases is lacking completely. It is, however, a prerequisite for the smooth application and maintenance (updates, upgradings) of a software that the documentation is complete, neatly structured, intelligible to its users and in agreement with the functionality of the program. To rule out deficiencies and consequences, the aims and function of the software documentation are to be defined and included in an appropriate guideline. By prescribing a uniform structure for all documentations and uniform use of the terms and concepts, such a guideline ensures the completeness and comparability of all documentations.
Bemerkung: Richtlinie für die Softwaredokumentation = Guideline for software documentation ; (PTB-Bericht PTB-IT-14)

Zurück zur Listen Ansicht