Software Dokumentation durchzieht den Software-Lebenszyklus . Es ist der sichtbare Teil des Software-Prozesses . Ohne sie kann Software nicht aufrechterhalten werden. Ohne sie kann der Anwender nicht trainieren und sie praktisch kann die Software nicht verwenden . Ohne sie neue Entwickler müssten neu erfinden das Rad in der Softwareentwicklung. Software-Dokumentation ist die wichtigste Manifestation der Software. Es ist der Wegweiser durch den Irrgarten Software . Definition von Software-Dokumentation
Technische Handbücher, Bedienungsanleitungen und andere Anweisungen, die die Nutzung und den Betrieb eines Software-Produktes oder Dienstleistungen zu erleichtern stellen Software-Dokumentation. Diese Dokumentation kann bei Bedarf der Quellcode , Fehlercodes und deren Bedeutung. Software-Dokumentation kann auch in elektronischer Form vorhanden sind, als PDF-Datei, als CD oder als Buch .
Software Documentation Standards
Das Institut für Elektrotechnik und Elektronik (IEEE ) hat Standards für die Software-Industrie die Software-Dokumentation entwickelt . Genannt IEEE 1063-2001 , "Standard für Software- Anwender-Dokumentation , " dieses Dokument Details den Inhalt , Architektur und Bedeutung eines Software-Dokumentation zu finden. Die International Standards Organization (ISO) und der Internationalen Elektrotechnischen Kommission ( IEC) auch Standards für Software-Dokumentation festgelegt haben. Die Standards werden als ISO /IEC 18019-2004 und ISO /IEC TR 9294 . Sie richten sich Software-Dokumentation und das Management sind. Jeder dieser Standards betont, dass Software-Dokumentation ist ein integraler Bestandteil des Software-Lebenszyklus .
Funktionen der Software Dokumentation
Alle Software-Lebenszyklus -Prozesse in der Entwicklung von Software als Software-Dokumentation aufgezeichnet. Software Dokumentation dient als schriftliche Informationen über Anforderungen Definitionen Gesamtsystem Spezifikationen , Spezifikation der einzelnen Komponenten und die umfassende Test-und Wartungspläne . Configuration Management-Tools sind auch sehr nützlich in der Software- Dokumentation.
Software Dokumentation für Entwickler
Die Bedeutung der Software-Dokumentation zu Software-Entwickler in der Tatsache, dass Software-Dokumentation enthält Informationen liegt auf den Betrieb des Software-Systems . Diese Information ist es möglich, die Software zu vervielfältigen oder passen sie an Wartung zur Art der Informationen dokumentiert ist in der Regel in Millionenhöhe an die Software-Firma . Solche Informationen könnten verloren gehen, wenn nicht dokumentiert als Entwickler kommen und gehen werden.
Software Dokumentation für Endbenutzer
Software Dokumentation hilft Endnutzer schätzen die Software schneller .
End - Handbücher Die Interaktion des Endkunden mit dem Computer. Ein Training Handbuch ist ein Beispiel für eine anwenderorientierte Handbuch. Es reduziert die Lernzeit zur produktiven Nutzung der Software , spart dem Endanwender Millionen von Dollar. Endbenutzer- Dokumente können auch ein Nachschlagewerk sein, dass Details die Funktionsweise des Systems oder eines Systems Administrator-Handbuch , dass die Einzelheiten zur Bedienung und Wartung des Systems .
