Gewusst wie: Schreiben von Softwaredokumentation

April 22

Nicht jede Softwaredokumentation geschrieben hat, aber jeder hat lesen Softwaredokumentation, die viel zu wünschen übrig gelassen. Wenn wir suchen, finden Sie Informationen über ein Stück Software, wollen wir wissen, was es tut, welche Betriebssysteme und andere Programme, mit denen es zusammenarbeitet, wie wir das machen kann und wie viel es kostet.

Anweisungen

Verschiedene Arten von Softwaredokumentation

1 Schreiben Sie, was die Software erledigt. Nach der Lektüre dieses Dokuments, sollte der Leser in der Lage zu bestimmen, ob er die Software braucht. Sein Sie sicher, dass alle Funktionen, die oft eine Liste mit allen Software-Funktionalitäten werden können.

2 Erläutern Sie die Funktionsweise der Software in Bezug auf andere Teile der Software. Dies kann andere Teile der Software nennen, die als Konkurrenten zu werden.Achten Sie darauf, was tut dieses Stück Software anders als die anderen zu skizzieren.

3 Skizzieren Sie die Typen von Schnittstellen und Code, die in der Software verwendet werden. In diesem Abschnitt soll den Leser wissen, welche Art von Wissen ein Benutzer haben sollte, um mit dieser Software arbeiten lassen. Dieser Teil der Softwaredokumentation wird von Programmierern und anderen technischen Menschen verwendet.

4 Machen Sie ein Dokument für den Benutzer der Software, so dass wer es liest mit dem Programm beginnen kann. Diese Art von Dokumentation kann Lernprogramme. Sie können auch Listen mit Befehlen oder Indizes der dem Benutzer die relevante Informationen finden werden.

5 Dokumentation zu schreiben, dass Vertriebsmitarbeiter verwenden können, wenn sie die Software verkaufen.Stellen Sie sicher, dass Sie alle Funktionen und Verkaufsargumente der Software aufgenommen haben.

Tipps & Warnungen

  • Scheuen Sie nicht über die Software-Experten zu konsultieren. Die meiste Zeit werden sie gerne der Softwaredokumentation besser behilflich sein.