Hallo,
Weis einer von euch wie man eine Dokumentation schreibt zu einer Software die Man selber entwickelt hat ?
mich interesiert, die Gliederung und das Layout einer solchen Doku.
vll. hat jemand eine Baspiel Doku mit Dummy texten…
Vielen Dank im Voraus !
Hallo,
Weis einer von euch wie man eine Dokumentation schreibt zu
einer Software die Man selber entwickelt hat ?
mich interesiert, die Gliederung und das Layout einer solchen
Doku.
Das haengt davon ab was fuer ein Programm du dokumentieren willst. Fuer Kommandozeilenprogramme finde ich die manpages ganz praktisch.
vll. hat jemand eine Baspiel Doku mit Dummy texten…
Die HTML-Version einer von mir geschriebenen Manpage ist hier:
http://perlgeek.de/software/mowyw.1
Gruesse,
Moritz
Weis einer von euch wie man eine Dokumentation schreibt
Ja, ich. Ich verdiene mein Brot damit.
Das haengt davon ab was fuer ein Programm du dokumentieren
willst.
Falsch! Das hängt davon ab, welche Zielgruppe dein Programm verwenden und deine Dokumentation verstehen soll! Danach richtet sich nämlich die Informationstiefe und die didaktische Ausrichtung deiner Dokumentation.
Welches Werkzeug du zur Doku-Erstellung benutzt, ist zweitranigg. Wichtig sind primär die zielgruppengerechte Ausarbeitung und die Einhaltung einschlägiger Normen, Gesetze, Richtlinien und Regelwerke.
Dann wird was d´raus. Versprochen!
Welches Werkzeug du zur Doku-Erstellung benutzt, ist
zweitranigg. Wichtig sind primär die zielgruppengerechte
Ausarbeitung und die Einhaltung einschlägiger Normen, Gesetze,
Richtlinien und Regelwerke.
Normen, Gesetze, Richtlinien und Regelwerke,
Das ist es wonach ich suche … Habe jedoch bisher noch keine erfolg gehabt.
Aber mal sehen vll werd ich doch noch was finden dank google 