Nicht jeder hat Software-Dokumentation geschrieben, aber jeder hat Software-Dokumentation , die eine Menge zu wünschen übrig lesen. Wenn wir schauen, um Informationen über ein Stück Software zu finden , wollen wir wissen, was es tut, welche Betriebssysteme und andere Programme mit der er arbeitet , wie wir es bekommen können , und wie viel es kostet. Things You
ein Stück Software
brauchen anzeigen Weitere Anweisungen
Verschiedene Arten von Software-Dokumentation
1
schreiben , was die Software tut. Nach der Lektüre dieses Dokuments , sollte der Leser in der Lage sein zu entscheiden, ob er die Software benötigt . Achten Sie darauf, alle Funktionen , die oft eine Liste aller Software-Funktionalitäten werden können, gehören .
2
Erklären Sie, wie die Funktionen der Software in Bezug auf andere Teile der Software . Dies kann schweigen von anderen Teile der Software , die als competitors.Be sicher sein, zu umreißen , was dieses Stück Software anders macht als die anderen sind .
3
Skizzieren Sie die Arten von Schnittstellen und Code, sind in der Software verwendet wird. Dieser Abschnitt sollte der Leser wissen, welche Art von Wissen, sollte ein Benutzer müssen mit diesem Stück Software zu arbeiten. Dieser Teil der Software-Dokumentation wird von Programmierern und anderen technischen Menschen genutzt werden.
4
Stellen eines Dokuments für die Benutzer der Software, so dass jeder, der es liest, wird in der Lage sein zu beginnen mit dem Programm . Diese Arten von Dokumentation Tutorials sein . Sie können auch Listen von Befehlen oder Indizes von denen Benutzer die relevanten Informationen zu finden.
5
Write Dokumentation , dass die Verkäufe Menschen verwenden können, wenn sie den Verkauf der software.Make sind sicher, Sie haben alle die aufgenommen werden Fähigkeiten und Alleinstellungsmerkmale der Software.