Ich bin auf der Suche nach Vorlagen / (Design) Guidelines / Richtlinien für die Erstellung von einer End-User Dokumentation für ein Software-Produkt. Speziell geht es mit um die Erstellung folgender Dokumente:
1.) Installation Guide (Wie installiere ich die Lösung) 2.) Operator / Administrator Handbuch (Wie betreibe ich die Lösung) 3.) User Manual 4.) Schulungsdokumente
Hab den Artikel gestern gelesen und finde den nicht schlecht, wobei es halt mehr oder minder nur eine Auflistung von den verschiedenen Hilfearten ist. Super ist gegen Schluss hin die Auflistung der Tools.
@Konstantin weil ich davon ausgehe, dass nicht jeder hier über ein dotnetpro-abo verfügt und diese Art von "Kauf dir ne Zeitung" Antwort hier nicht her gehört.
Unter folgendem Link findest Du zwar keine Beschreibung welche Funktion Deiner Software im Handbuch auftauchen muss und welche nicht, da diese Entscheidung wohl oder übel von Dir selbst getroffen werden muss, aber eine recht umfangreiche Hilfestellung, nach welcher Struktur und Systematik ein Benutzerhandbuch aufgebaut sein sollte. Writing Revisable Manuals
Nicht nur "eher" sondern meiner Meinung nach ausschließlich, weil ja nur die Code-Kommentare/-Dokumentation in eine externe Form gebracht werden. Für das Beschreiben des eigentlichen Handlings nutzt das leider recht wenig.
Wir nutzen auch Sandcastle für unsere Dokumentationen.
Durch die Verwendung von DocProject DocProject for Sandcastle ist man sogar in der Lage zusätzliche Dokumente hinzuzufügen und einzubinden.
Einziger Nachteil bis jetzt: Es ist kein WYSIWYG möglich. Aber wenn man HTML kann und die VS-Unterstützung nutzt, lassen sich recht schnell Dokumente erstellen (incl. Diagrammen sogar)
