Guten Morgen 
Habt ihr tipps für mich, was ich beim erstellen einer anwenderdoku beachten muss?
wie ich vorgehen kann?
etc?
in für alle tipps glücklich
Guten Morgen,
mir fällt grad nur eins ein:
die Doku muss für jeden!!!(also auch für den hausmeister der ausm mund tropft), nachvollziehbar und verständlich sein.
gruß
rasta
[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]
i know
also, ich hab auch schon von einer seite mir fragen kopiert, die auf jeden fall beantwortet werden müssen.
klapper auch schon die ganze zeit das internet ab, nach einen grundgerüst oder so dafür.
[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]
Tach auch…
nun gibt natuerlich einige strukturelle dinge, die man beachten muss:
die doku ist meist aufwaendiger als das produkt/programm selbst *grins* zumindest kostets oft mehr zeit.
Also…hier mal schnell ausm kopf eine gliederung
1.) Titelblatt (name software, name progger, version)
2.) versionsverlauf (release updates?)
3.) what's new...
4.) sinn und zweck der software
5.) system voraussetzungen (OS,RAM,Aufloesung, sound?)
(Anwendervoraussetzungen)
6.) installationsanleitung (schritt fuer schritt)
u.U. Betriebssysteme berücksichtigen)
7.) Einleitung
8.) modulerklaerungen (je nach produkt verschieden)
9.) kontakt und support
10.) FAQ
11.) impressum und dankesworte
das fiel mir jetzt spontan ein…
grusz
PK
Hallo
Habt ihr tipps für mich, was ich beim erstellen einer
anwenderdoku beachten muss?
Schwierige Frage, mal ein paar Ideen von mir…
Erstmal überlegen wie du das ganze aufmachst, es gibt zwei übliche Wege, einmal Referenz bezogen und andererseits auf Bedienung.
Die meisten Dokus kommen von der Referenz, es wird eine Liste der Funktionen erstellt, mehr oder weniger sinnvoll, und einzeln beschrieben.
In meinen Augen der bessere Weg ist sich den Arbeitsweg des Benutzers vor Augen zu halten and an Hand dieses Leitfadens die Funktionen zu beschreiben, dazu ist dann auch noch eine gute Gliederung, Inhaltsverzeichnung, Index oder so wichtig, um einzelnes Nachschlagen zu ermöglichen.
Ich finde es zum Beispiel ziemlich nervig wenn man für einfache, zusammengehörige Arbeitsschritte tausend Mal blättern muß.
„Tanken des Autos“:
Öffnen sie die Tankklappe (siehe Kapitel Türen und Klappen)
Öffnen sie den Tankverschluß (siehe Kapitel Wartung, Unterkapitel Bestriebsstoffe, Absatz Öffnungen)
Füllen sie den Tank mit Benzin (siehe Band 2, Kapitel empfohlene Betriebs und Verbrauchsstoffe)
.
.
.
Andererseits…
Mach es dir einfach und drucke 236 leere Seiten aus, Doku liesst sowieso niemand 
Glaubst du nicht? Schreibe in einem wirklich wichtigen Kapitel einen Satz wie „wer das liesst bekommt 10 €“, glaube nicht das du viel zahlen musst
(Übrigens schon ausprobiert, in einem betriebsinternen Projekt )
Gruß, DW.
danke, das hilft doch schonmal viel weiter
[Bei dieser Antwort wurde das Vollzitat nachträglich automatisiert entfernt]
Bilder, Bilder, Bilder!
Versuche nicht zu erklären wie man die Maus 12cm nach oben links bewegt, auf etwas klickt das wie eine Tomate ausssieht, aber nicht genauso sondern grün, und dann…
Sinnvolle Bilder, es ist kein 1600x1400 Screenshot nötig, um ein 64x64 Icon zu zeigen.
Keine internen oder unüblichen Fachbegriffe verwenden oder sofort im Anschluß erklären (mehrfach, nicht jeder startet bei dem gleichen Kapitel).
zufälligerweise
bin ich auf Deinen Beitrag gestossen.
Mein Sohn befindet sich offenbar in genau der gleichen Situation. Diese jungen Fachinformatiker Anwendungsentwicklung befinden sich gerade in den Abschlussprüfungen. Die schriftlichen Prüfungen hatten sie am letzten Montag und Dienstag und nun haben sie ca. 3 Wochen Zeit ihre Projektarbeit auszuarbeiten und das ist wohl (so zumindest mein Eindruck) eben genau dieses.
Ich habe mir erlaubt Dein Posting abzukopieren und es meinem Sohn zu senden.
Das Sternchen ist von mir
Und wenn ich Dir mal helfen kann (ganz im Sinne von wer-weiss-was) nur zu gerne…
Gruss
Anonym
Hallo,
i know
also, ich hab auch schon von einer seite mir fragen kopiert,
die auf jeden fall beantwortet werden müssen.
Cool,
könntest du diese Fragen hier vielleicht posten, ist bestimmt auch für andere hilfreich, für mich auf jedenfall *g*
Gruß
Marcel
Fragen die beantwortet werden müssen in der doku
Checkliste zur Anwenderdokumentation
Inhalt
Vollständigkeit
Einheitlichkeit
Verständlichkeit
Einhaltung des Standards
Sonstiges
Vollständigkeit
-
Sind alle Funktionen des Softwareproduktes im Anwenderhandbuch beschrieben?
-
Ist die Bedienung jeder Funktion vollständig und eindeutig dokumentiert?
-
Ist ein Inhaltsverzeichnis vorhanden?
-
Wird deutlich, wie die fachlichen Verarbeitungsschritte im Programm umgesetzt werden?
-
Ist die Tastenbelegung aller Funktionen beschrieben und stimmt die Beschreibung mit dem Programm überein?
-
Enthält die Dokumentation ein Verzeichnis der Fehlermeldungen mit Erläuterungen?
Einheitlichkeit
7. Sind Bezeichnungen und Funktionsbeschreibungen einheitlich?
8. Werden im Programm und in der Dokumentation identische Begriffe für den gleichen Sachverhalt verwendet?
-
Ist die Dokumentation einheitlich strukturiert, ist sie systematisch durchnumeriert?
-
Werden Seitennummern, Überschriften, Kopf- und Fußzeilen immer einheitlich angegeben?
-
Entsprechen die Abbildungen von Masken im Anwenderhandbuch den Masken im Programm?
Verständlichkeit
12. Ist die Dokumentation sprachlich und inhaltlich verständlich?
13. Sind die Beispiele im Anwenderhandbuch am Produkt nachvollziehbar?
-
Werden komplexe Abläufe durch Grafiken veranschaulicht?
-
Sind die Referenzen korrekt?
-
Stimmt die Dokumentation mit dem Programm und das Programm mit der Dokumentation überein?
-
Ist es einfach, die Beschreibung eines bestimmten Problems in der Dokumentation zu finden?
Einhaltung des Standards
18. Enthält die Anwenderdokumentation mindestens folgende Teile:
die Kurzeinführung (schriftlich oder auf Diskette),
das Anwenderhandbuch
das PC-Hilfesystem (im Programm)?
-
Entspricht die formale Gliederung der einzelnen Fächer des Anwenderhandbuchs der Beschreibung im Standard?
-
Sind die wichtigsten Bildschirmmasken mindestens einmal im Handbuch abgebildet?
-
Gibt es einen Abschnitt, in dem Probleme bei der Bedienung behandelt werden, zu denen keine Fehlermeldung angezeigt wird?
-
Entsprechen der Aufbau des Ordners, der Satzspiegel und die Ergänzungslieferungen dem Standardvorschlag?
-
Entsprechen die Spezifikationen der Programmkarte - falls vorhanden - dem Standardvorschlag?
-
Beschreibt die Kurzanleitung - falls vorhanden -die wesentlichen Programmfunktionen (z.B. im Hilfesystem)?
-
Entspricht die Eingliederung der Informationen zur Netzversion ins Handbuch der Beschreibung im Standard?
-
Sind die Absätze am Rand mit dem Netzwerksinnbild markiert?
-
Entspricht die Gliederung der netzwerkspezifischen Funktionen in Kapitel und Unterkapitel der Beschreibung im Standard?
-
Enthält die Leistungsbeschreibung (als eigenständiger Artikel oder im Handbuch integriert) die Standard-Gliederungspunkte
in der angegebenen Reihenfolge?
-
Werden in der Leistungsbeschreibung die Standardtexte verwendet?
-
Ist die Leistungsbeschreibung im Fach ANHANG - falls vorhanden - eingeordnet?
-
Entspricht der Satzspiegel der Leistungsbeschreibung dem der Handbücher?
-
Entspricht der Inhalt des Beipackzettels und der Readme-Datei dem Standard?
-
Werden im Beipackzettel und in der Readme-Datei die Standard-Texte verwendet?
-
Entspricht das Layout des Beipackzettels und der Readme-Datei dem Standard (vgl. Musterseiten)?
Sonstiges
35. Gibt es Mängel in der Dokumentation, die nicht mit der Beantwortung obiger Fragen erkannt wurden?
1 „Gefällt mir“