| 

.NET C# Java Javascript Exception

7
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

Danke im Voraus für die Hilfe
04.05.2011
Gast
71 1 3
4 Antworten
3
In der aktuellen Ausgabe der dotnetpro (5/2011) ist das ein Schwerpunktthema.
Vielleicht hilft dir das ja weiter.
04.05.2011
Christian M. Müller 251 1 7
schon klar...
Mario Priebe 04.05.2011
Was ist an seiner Antwort so schlimm?
Konstantin 04.05.2011
Danke für den Hinweis!
– Gast 04.05.2011
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.
Voi 04.05.2011
2
@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.
Mario Priebe 04.05.2011
2
Also ich finde die Antwort prima. Wenn in dem Artikel Hilfestellung gegeben wird, ist es doch gut!
KN 05.05.2011
3
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
04.05.2011
SensenMannLE 1,2k 2 9
2
Schau dir mal des an:

http://schaedlerdaniel.wordpress.com/2008/07/22/automatische-dokumentation-visual-studio-sandcastle/

inklusive von dem was dann beim ersten Link angeführt ist.

Wobei ich dir im Vorfeld sagen musst, dass des eher für Entwickler- Dokus taugt.
04.05.2011
Voi 216 3
Joachim 3,1k 4 9
1
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.
SensenMannLE 04.05.2011
1
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)
04.05.2011
MyKey0815 1,6k 2 9

Stelle deine Dokumentation-Frage jetzt!