Knowledge Base "Best Practices für Technische Dokumentation"
Die Knowledge Base „Best Practices Technische Dokumentation“ ist ein elektronischer Leitfaden für Autoren Technischer Dokumentation. Sie liefert mit wenigen Klicks das nötige Fachwissen zum Erstellen hochwertiger Benutzerhandbücher und Online-Hilfen.
Die Knowledge Base ist online jederzeit und an jedem Ort verfügbar. Sie enthält stets die neuesten Inhalte aller meiner Bücher, Konzepte und sonstigen Arbeitshilfen. Darüber hinaus enthält die Knowledge Base teilweise auch noch nicht als Bücher veröffentlichte Informationen und Hilfsmittel. Stets auf dem letzten Stand.
Wozu?
Die Knowledge Base liefert Ihnen mit wenigen Klicks die erforderlichen Best Practices zum Erstellen hochwertiger Benutzerdokumentation.
Die Knowledge Base verzichtet konsequent auf lange theoretische Abhandlungen und gibt Ihnen stattdessen unmittelbar praktisch anwendbare Empfehlungen, die sich leicht einprägen und auf Ihre eigene Arbeit übertragen lassen.
Um die Schreibregeln zu verstehen, brauchen Sie kein Linguistik-Studium. Um die Gestaltungsregeln umzusetzen, müssen Sie kein Grafiker sein. Zu allen Regeln gibt es anschauliche Beispiele.
Die Knowledge Base ist in klarem, einfachem Englisch geschrieben und wird durch zahlreiche Hinweise in deutscher Sprache ergänzt. Fast alle Regeln gelten universell, sodass Sie die Knowledge Base auch dann nutzen können, wenn Sie in anderen Sprachen als Deutsch und Englisch schreiben.
Für wen?
Die Knowledge Base wurde für alle Personen entwickelt, die an der Erstellung von Technischer Dokumentation beteiligt sind, egal ob aus den Bereichen
- Technische Redaktion
- Entwicklung
- Schulung
- Produktmanagement
Die Knowledge Base liefert ohne eigenen Erstellungsaufwand einen fertig einsetzbaren, einheitlichen und regelmäßig aktualisierten Redaktionsleitfaden für Ihr gesamtes Team. Zu unschlagbar günstigen Kosten im Vergleich zur Eigenentwicklung eines Redaktionsleitfadens.
Inhalte
Die Knowledge Base umfasst alle wesentlichen Themengebiete im Zusammenhang mit dem Erstellen einer Technischen Dokumentation:
Regeln zum Thema Strukturierung
Für Technische Dokumentation die richtige Gliederung zu finden, ist oft nicht so einfach, wie es auf den ersten Blick erscheint:
- Wenn Sie denken, dass die Struktur Ihres Dokuments der Struktur der Komponenten und Funktionen Ihres Produkts folgen sollte, liegen Sie falsch.
- Wenn Sie denken, dass die Dokumentform, die Sie selbst bevorzugen, auch Ihre Kunden bevorzugen, liegen Sie falsch.
- Wenn Sie denken, dass alle Ihre Informationen wichtig sind, liegen Sie falsch.
Die Knowledge Base gibt Ihnen bewährte Regeln und Tipps an die Hand, mit denen Sie eine Struktur finden, die:
- das mentale Modell der Benutzer widerspiegelt
- die Informationen in die optimale didaktische Reihenfolge bringt
- es den Benutzern leicht macht, die benötigten Informationen zu finden
- Wichtiges von weniger Wichtigem trennt
Regeln zum Thema Gestaltung
Für den ersten Eindruck gibt es keine zweite Chance. Ästhetisches Design kann gute Inhalte nicht ersetzen, ist aber dennoch ein Schlüsselfaktor effektiver Technischer Kommunikation. Ein optisch attraktives und übersichtliches Dokument motiviert seine Adressaten eher zum Lesen als ein unprofessionell anmutendes Dokument. Ebenfalls nicht zu unterschätzen ist die Tatsache, dass ein klares Design und durchdachte Formatvorlagen (Templates) auch Sie als Autor motivieren und Ihnen dabei helfen, ebenso klare und benutzerfreundliche Inhalte zu schreiben.
Die Knowledge Base fasst die grundlegenden zu berücksichtigen Designprinzipien zusammen und liefert konkrete Beispiele als Ausgangspunkte für Ihre eigenen Anpassungen.
Ästhetik ist allerdings nicht das Einzige, worauf Sie beim Entwurf einer Formatvorlage für eine Technische Dokumentation achten sollten. Usability, Lesbarkeit und Einfachheit sind mindestens ebenso wichtig. Absatzformate und Zeichenformate zu definieren, die für die Autoren beim Erstellen und Pflegen eines Dokuments effizient anwendbar sind, erfordert viel Erfahrung als Technischer Redakteur. Die in der Knowledge Base angegeben Regeln sind die Essenz dieser Erfahrung. Sie werden Ihnen helfen, Fehler zu vermeiden, die andere Autoren schon viel Zeit und Ärger gekostet haben.
Regeln zum Thema Schreiben
Jeder kann schreiben, aber nicht jeder kann so schreiben, dass es jeder versteht.
- Wenn Sie etwas vollständig erklärt haben, bedeutet das nicht, dass Ihre Informationen auch nützlich sind.
- Wenn Sie etwas richtig erklärt haben, bedeutet das nicht, dass Sie es auch in der richtigen Art und Weise erklärt haben.
- Wenn ihre Sätze grammatisch richtig sind, bedeutet das nicht, dass sie auch verständlich sind.
Die Knowledge Base liefert Ihnen erprobte Schreibregeln und praktische Tipps, mit deren Hilfe Sie Inhalte erstellen, die:
- optimal strukturiert sind
- klar geschrieben sind
- einfach zu verstehen sind
- tatsächlich hilfreich sind
Regeln zum Thema Visualisieren
Worte sind nicht immer das beste Medium, um technische Informationen zu vermitteln. Manchmal kann ein Bild, eine kleine Animation oder ein kurzes Video innerhalb weniger Sekunden intuitiv zeigen, was Worte kaum zu beschreiben vermögen.
Die Knowledge Base liefert Ihnen bewährte Best Practices einer effektiven Visualisierung. Dies umfasst die Themen:
- Wahl des richtigen Mediums und Orts
- Allgemeine Gestaltungsprinzipien
- Bilder allgemein
- Bilder von Hardware
- Bilder von Software
- Video-Design
- Video-Produktion
- Interaktive Inhalte
Zweisprachige Ausgabe Englisch + Deutsch
Viele Handbücher und Online-Hilfen werden auch im deutschen Sprachraum zunächst in englischer Sprache erstellt und entweder gar nicht oder erst später ins Deutsche übersetzt.
Um Sie in allen Szenarien gleichermaßen zu unterstützen, ist die deutsche Version der Knowledge Base zweisprachig aufgebaut:
- Englisch: Alle Themen, die primär für die englische Sprache gelten, sind in englischer Sprache verfasst. Alle global relevanten Themen werden ebenfalls in englischer Sprache behandelt. Dabei sind Grammatik und Wortwahl bewusst einfach gehalten. Durchschnittliche Englischkenntnisse reichen zum Verständnis.
- Deutsch: Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben.
Screenshots
Aufklappbare Texte sowie eine übergreifende Suchfunktion und ein übergreifender Index führen Sie mit wenigen Klicks schnell zu den relevanten Inhalten.
Beispiel-Themen (Klicken Sie auf das jeweilige Bild, um es zu vergrößern):
Übergreifender alphabetischer Index:
Übergreifende Suchfunktion:
Systemanforderungen
Sie benötigen lediglich einen Computer oder ein Tablet mit einem aktuellen Browser und Internetzugang.
Preis und Bestellung
Der Preis richtet sich nach der Anzahl der Benutzer sowie einer möglichen firmenspezifischen Anpassung (optional). Auf Anfrage erstelle ich Ihnen gerne ein individuelles Angebot.