Das klingt so, als würden Sie Dokumentation beschreiben .

Hier ist eine Aufschlüsselung von Warum:

* Erzählende Beschreibung: Die Dokumentation verwendet natürliche Sprache, um zu erklären, was ein Programm tut, wie es funktioniert, und in seinen beabsichtigten Anwendungsfällen. Stellen Sie sich dies als "Geschichte" der Software vor.

* Grafische Beschreibung: Um weiter zu klären, enthält die Dokumentation häufig Bilder wie:

* Screenshots: Zeigen Sie die Schnittstelle des Programms und wie Sie sie navigieren.

* Diagramme: Veranschaulichung von Beziehungen zwischen verschiedenen Teilen des Programms oder Prozesses.

* Flowdiagramme: Darstellung der logischen Schritte eines Prozesses innerhalb des Programms.

* Handbuch &Referenz: Eine gute Dokumentation dient sowohl als Leitfaden (beigebracht den Benutzern, wie man Dinge macht) als auch als Referenz (schnelle Antworten auf bestimmte Fragen).

Verschiedene Dokumentationsformen

Die Dokumentation kann je nach Komplexität des Programms und der Zielgruppe viele Formen annehmen:

* Benutzerhandbücher: Ziel an Endbenutzer und konzentriert sich darauf, wie die Funktionen des Programms effektiv verwendet werden.

* API -Dokumentation: Für Entwickler, die die Funktionalität des Programms in andere Anwendungen integrieren möchten.

* Technische Dokumentation: Bereichen sich an Entwickler, die an dem Programm selbst arbeiten und seine Architektur, Codebasis und interne Arbeiten abdecken.

* Online -Hilfe: In die Software integriert und kontextsensitive Unterstützung in der Schnittstelle des Programms anbietet.

* Tutorials: Schritt-für-Schritt-Anleitungen, die Benutzer durch bestimmte Aufgaben oder Prozesse führen.

Lassen Sie mich wissen, wenn Sie möchten, dass ich diese Arten von Dokumentationen näher erläutern soll!