nicht angemeldet
Hallo Freunde des gehobenen Forumsgenusses,
Da ich selbst freie Software schreibe und (inzwischen auch) dokumentiere würde ich gerne von euch wissen, was alles in eine solche Dokumentation gehört.
Im Moment schreibe ich für mein Lieblingsprojekt zwei Dokumentationen:
Eine in PHPDoc und eine für Leute, die die Software einfach nur einsetzen wollen ohne zu wissen, wie sie funktioniert: Benutzer-Dokumentation.
Wie handhabt ihr das? Kennt ihr vielleicht Quellen, in denen beschrieben wird, wie man Dokumentationen für die verschiedenen Zielgruppen zu schreiben hat? Seht ihr in meinen Dokumentationen Fehler / Sachen, die ihr anders machen würdet?
Gruß
Alexander Brock
