DseWiki: SoftwareDokumentation

Software Dokumentation

StartSeite | Neues | TestSeite | ForumSeite | Teilnehmer | Kategorien | Index | Hilfe | Einstellungen | Ändern

Siehe

WardsWiki:ReadTheFineManual

Aspekte für Dokumentation

Zielgruppe

An wen soll sich die Dokumentation richten?

Dokumentations-Methoden

Wo wird dokumentiert?

In zusätzlichen Dokumenten
Innerhalb der Programmquelltexte (sogenanntes LiterarischesProgrammieren)
Extern zum Produktionscode, z.B. durch Tests

Like it or not, most programmers don't read the written documentation for a system; instead, they prefer to dig right into the code.

Scott W. Ambler; http://www.sdmagazine.com/documents/s=826/sdm0306d/

Durch den Quelltext selbst (siehe DokumentationsTool)

In welcher Form wird dokumentiert?

UML (Unified Modelling Language) -> http://www.uml.org
UML / Use Cases (requirements analysis) -> http://www.usecases.org

Verteilung der Dokumentation

Produktion von Handbüchern auf Papier
OnlineDokumentation? in Form von HTML, PDF, HelpDateien?, die auf dem VerteilMedium? der Software beigefügt wird.
Dokumentation im Internet
CrossMediaPublishing für alle möglichen Ausgabeformate

Apple Publications Style Guide (auch für Python verwendet)

Siehe auch: WikiAlsDokumentationsTool

KategorieDokumentation

StartSeite | Neues | TestSeite | ForumSeite | Teilnehmer | Kategorien | Index | Hilfe | Einstellungen | Ändern
Text dieser Seite ändern (zuletzt geändert: 5. August 2004 9:18 (diff))