Hi,
ich soll demnächst ein Benutzerhandbuch / Dokumentation über eine Software schreiben. Hat da jemand einen Tipp für mich, wo ich Infos herbekomme, wie so der ungefähre Aufbau ist und was da unbedingt drinne stehen soll ?
Gruß
Lianna
Hallo Lianna,
orientier dich doch einfach an bereits existierenden Dokumentationen zu ähnlichen Produkten.
Schreib nichts rein, was der Benutzer sich sowieso schon hat denken können, sonst produzierst du einen mehrere hundert Seiten dicken Wälzer wie Microsoft, in dem dann so geniale Hinweise stehen wie etwa: „Wählen Sie den Menüpunkt „Datei, öffnen“ um eine Datei zu öffnen.“
Solche Sätze sind völlig unnütz und blähen die Dokumentation nur auf.
Außerdem muss ich ehrlich sagen, dass ich es eine (leider weit verbreitete) Unsitte finde, die Erklärungen in verschachtelte Sätze zu packen, die nicht der tatsächlichen Reihenfolge entsprechen, also z.B. „Wählen Sie „bestätigen“ im Menü „Löschen“, das Sie unter dem Menüpunkt „Datei“ finden, um die Datei zu löschen.“
Es arbeitet sich sehr schlecht nach solchen Dokumentationen. Man könnte das auch anders schreiben: "Um eine Datei zu löschen, wählen Sie zunächst den Menüpunkt „Datei“, hier die Option „Löschen“ und anschließend „bestätigen“. Gleiche Aussage, nur viel leichter auszuführen.
Ach ja, und du solltest darauf achten, dass die Punkte in deiner Dokumentation genau so heißen wie im Programm. Wenn der Punkt im Programm „Delete“ heißt, dann solltest du ihn in der Dokumentation nicht „Löschen“ nennen, sonst wird das für den Benutzer ein Ratespielchen.
Viel Spaß beim Schreiben.
Schöne Grüße
Petra
Sorry, aber die meisten Tipps sind für die Tonne!
orientier dich doch einfach an bereits existierenden
Dokumentationen zu ähnlichen Produkten.
Das ist ein Widerspruch in sich selbst. Wer nämlich keine Ahnung von Dokumentationsarbeit hat, wird auch nicht erkennen, ob er sich zufällig an einer guten oder schlechten Vorlage orientiert.
Schreib nichts rein, was der Benutzer sich sowieso schon hat
denken können
Was kann sich denn der Benutzer denken und was nicht? Und wer ist „der Benutzer“ überhaupt? Die Zielgruppe der Softwarebenutzer ist doch nicht homogen! Da gibt’s alles - vom blutigen Anfänger bis zum Profi!
„Wählen Sie den Menüpunkt „Datei,
öffnen“ um eine Datei zu öffnen.“
Solche Sätze sind völlig unnütz.
So, so… und der blutige Word-Anfänger? Der fände diesen Satz in der Tat genial!
Man könnte das auch anders schreiben: "Um eine Datei zu
löschen, wählen Sie zunächst den Menüpunkt „Datei“, hier die
Option „Löschen“ und anschließend „bestätigen“.
Damit hast du völlig recht! (Allerdings dürfte nach deiner Logik dieser Satz gar nicht drin stehen. Wie man löscht, kann man sich doch denken…)
Der einzig wahre Weg zu einer guten Dokumentation:
Man kaufe für einige tausend Euro deutsche und europäische Dokumentations- und Produktnormen, studiere die Produkthaftungsgesetze, arbeite sich in die Thematik der CE-Konformität ein, baue seine didaktischen Fähigkeiten aus, festige seine Kenntnisse in der benötigten Hard- und Software, mache sich firm in Sachen Qualitätssicherung und fange dann mit seinem Erstlingswerk an.
Oder man lasse sich zum Technischen Redakteur und Illustrator ausbilden.
In beiden Fällen wird man schon nach wenigen Jahren Berufserfahrung seine erste wirklich gute (sprich: verständliche und haftungssichere) Dokumentation präsentieren können.
Also: ran an den Speck! Und nichts für ungut…
1 Like
Der einzig wahre Weg zu einer guten Dokumentation:
Man kaufe für einige tausend Euro deutsche und europäische
okumentations- und Produktnormen, studiere die
rodukthaftungsgesetze, arbeite sich in die Thematik der :CE-Konformität ein, baue seine didaktischen Fähigkeiten aus, festige :seine Kenntnisse in der benötigten Hard- und Software, mache sich :firm in Sachen Qualitätssicherung und fange dann mit seinem :Erstlingswerk an.
Oder man lasse sich zum Technischen Redakteur und Illustrator :ausbilden.
In beiden Fällen wird man schon nach wenigen Jahren Berufserfahrung :seine erste wirklich gute (sprich: verständliche und haftungssichere)
Ich bin zwar noch im Studium, aber ich hab nicht Jahre Zeit für die Dokumentation, sondern maximal 1/2.
Auf lange Sicht ist dein Tipp wahrscheinlich der beste, aber ich brauch erst einmal ne Einführung à la „Dokumentation schreiben für Dummies“ oder ich brauch wirklich ne gute Dokumentation für irgendeine Anwendersoftware als Beispiel.