Was gehört alles in eine richtige Dokumentation?

[Nintendo]

Hallo,

- Schritt für Schritt Anleitung der Bedienung der Software

- Bei Softwareentwicklungssystemen genügend Beispiele, die möglichst alle Faähigkeiten des Entwicklungssystems abdecken. Plus eine ausführliche Hilfe für alle Prozeduren, Funktioen, Klassen, Methoden,...

- Verständliche Anleitung zur Benutzung von Zusatztools.

- Das heißt aber bei Kommandozeilenprogrammen dann auch:
jede Option in ihrer Bedeutung genau erklären
Genaue Angabe, in welcher Reihenfolge die Optionen angegeben
werden müssen oder besser noch das Tool so programmieren, das die
Reihenfolge der Optionen egal ist.

- Für diesen Fall auch Beispiele für die Verwendung des
Kommandozeilenprogrammes.

Bei Gui Programm:
- sinnvolle Voreistellungen
- wiederum Erklärung aller auswählbaren Optionen mit deren Bedeutung
- Auch hier Beispiele mit verschiedenen Einstellungen.

Ich hoffe, das hilft erst mal. Inzwischen ist mir jemand zuvor gekommen. Der hat schon alles Wichtige zusammengefasst.