Best Practices
Technische Dokumentation

Suchen Sie nach Informationen, wie Sie gute Benutzerhandbücher, Online-Hilfen
und andere Formen Technischer Dokumentation schreiben?
Dann sind Sie hier richtig!
 

Die Bücher

Stehen Sie vor der Aufgabe, verständliche und benutzerfreundliche Technische Dokumentation zu schreiben? Haben Sie aber keine Zeit für ein Studium der theoretischen Hintergründe? Dann können Ihnen meine Bücher der Reihe Lösungen zur Technischen Dokumentation helfen. Die Bücher zeigen Ihnen die bewährten Best Practices, die Sie beim Entwerfen und Schreiben von Benutzerhandbüchern, Online-Hilfen und anderer Technischer Dokumentation kennen sollten. Kleine lange und langweilige Theorie, sondern praktische Tipps, klare Regeln und viele Beispiele!

Überzeugen Sie sich selbst: Wenn Sie unten auf das jeweilige Bild klicken, können Sie umfangreiche Teile der Bücher einsehen. (Wenn Sie einen Nutzen aus den enthaltenen Informationen ziehen, seien Sie bitte so fair und erwerben Sie ein Exemplar.)
(Für Vorschau anklicken)
Planning and Structuring User Assistance - Wie Sie Handbücher, Online-Hilfen und andere Formen Technischer Dokumentation benutzerfreundlich aufbauen und den Informationszugriff erleichtern

Zweisprachige Ausgabe:
Englisch + Deutsch
Ca. 202 Seiten
ISBN 978-3-943860-05-4

Autor: Marc Achtelig
(Für Vorschau anklicken)
Designing Templates and Formatting Documents - Wie Sie Benutzerhandbücher und Online-Hilfen attraktiv und gut lesbar gestalten, und wie Sie effiziente Formatvorlagen erstellen

Zweisprachige Ausgabe:
Englisch + Deutsch
Ca. 260 Seiten
ISBN: 978-3-943860-07-8

Autor: Marc Achtelig
(Für Vorschau anklicken)
Writing Plain Instructions - Wie Sie Handbücher, Online-Hilfen und andere Formen Technischer Kommunikation schreiben, die jeder Benutzer versteht

Zweisprachige Ausgabe:
Englisch + Deutsch

Ca. 524 Seiten
ISBN 978-3-943860-09-2

Autor: Marc Achtelig
Falls Sie nur sehr wenig Zeit haben, sich in das Schreiben guter Technischer Dokumentation einzuarbeiten, bietet Ihnen das Buch „Basiswissen Technische Dokumentation“ eine kompakte Zusammenfassung der wichtigsten Best Practices der vorstehend genannten Bücher.
(Für Vorschau anklicken)
Basiswissen Technische Dokumentation:
„How to Write That F***ing Manual“ - Ohne Umschweife zu benutzerfreundlichen Handbüchern und Hilfen

Zweisprachige Ausgabe Englisch + Deutsch
Ca. 256 Seiten
ISBN 978-3-943860-01-6

Autor: Marc Achtelig
Preis und Bestellmöglichkeit

Die Bücher sind sowohl als gedruckte Bücher erhältlich als auch als E-Books.
Preise und Bestellmöglichkeiten finden Sie hier.
 

Der Companion

Der Technical Writers’ Companion (zweisprachig Englisch + Deutsch) ist im Wesentlichen ein elektronischer Sammelband der Bücher. Wenn Sie gerade an einem Dokument arbeiten und eine bestimmte Best Practice nachschlagen möchten, ist die elektronische Version mit ihrer globalen Suchfunktion und ihrem Gesamtindex unschlagbar schnell. Auch ist Companion kostengünstiger als der Gesamtpreis der Bücher.
Fragen, die der Companion beantwortet
Technische Dokumentation
strukturieren
Welche Dokumente sollten Sie vorsehen? Gedruckte Handbücher (PDF), Online-Hilfe (HTML) oder beides?

Welche Abschnitte sollte jedes der Dokumente enthalten? In welcher Reihenfolge?

Welche Navigationshilfen können Sie anbieten, um sicherzustellen, dass die Leser die wichtigen Informationen auch finden, die irgendwo in Ihren Dokumenten stecken? (Machen wir uns nichts vor: Niemand liest eine Bedienungsanleitung von vorne bis hinten.)
Technische Dokumentation
gestalten
Wie sollte das Layout Ihrer Dokumente aussehen? Welche Seitengröße, Fenstergröße, Farben, Schriftarten, Zeilenlängen, Zeilenabstände, Absatzformate, Zeichenformate, Tabellenformate … sollten Sie vorsehen?

Was macht ein Design benutzerfreundlich, sodass Leser die Informationen einfach finden, optimal nachvollziehen und dauerhaft behalten können?

Was macht eine Formatvorlage (Template / Stylesheet) autorenfreundlich, sodass …
… Sie die Formate effizient zuweisen können?
… sich der Layoutprozess möglichst weitgehend automatisieren lässt?
… Sie die Formate später jederzeit leicht wieder ändern können, sollte dies erforderlich werden?
Technische Dokumentation
schreiben
Wie sollten Sie schreiben, sodass jeder Leser versteht, was Sie meinen?

Wie vereinfachen Sie Kapitel, Abschnitte, Sätze und sogar einzelne Wörter?

Welche Benennungen sollten Sie in Technischer Dokumentation verwenden, und welche Begriffe sollten Sie vermeiden?

Häufige Fragen zu Rechtschreibung und Zeichensetzung.
Sowie vieles mehr …

Warum sehen Sie nicht einmal selbst hinein? Hier ist eine sehr freizügige kostenlose Vorschau auf beinahe die Hälfte aller Inhalte. (Wenn Sie einen Nutzen aus den enthaltenen Informationen ziehen, seien Sie bitte so fair und erwerben Sie eine Lizenz.)
Preis und Bestellmöglichkeit

Der Preis für eine zeitlich unbeschränkte Lizenz beträgt € 99 plus Mehrwertsteuer.
Sie können eine Lizenz hier erwerben.
 

Das Template

Formatvorlagen (Templates) zu erstellen, die nicht nur professionell aussehen, sondern auch professionell funktionieren, kann viel Aufwand bedeuten - oft mehrere Tage. Wenn Sie auf einem guten, bereits bestehenden Template aufsetzen können, geht es wesentlich einfacher und schneller. Das Starter-Template für Word / OpenOffice / LibreOffice ist ein solches Template.

Entwickelt mit einem Hintergrund von mehr als 20 Jahren Erfahrung in der Erstellung Technischer Dokumentation, erfüllt das Starter-Template sowohl die Anforderungen der Leser als auch die Anforderungen der Autoren. Für die Leser: Das Design des Dokumentations-Templates ist dezent und unaufdringlich, sodass sich die Leser voll auf die Inhalte des Dokuments konzentrieren kann. Für die Autoren: Ein ausgereifter Formatekatalog macht das Formatieren Ihrer Inhalte einfach. Die Formate sind außerdem so angelegt, dass Sie die Formate, falls nötig, jederzeit einfach an Ihre speziellen Anforderungen und an Ihre hausinterne Corporate-Identity anpassen können.

Die folgenden Abbildungen zeigen Ausschnitte aus dem mit dem Starter-Template mitgelieferten Design-Guide. Dieser Design-Guide wurde vollständig mit Hilfe des Starter-Templates formatiert (klicken Sie auf ein Bild, um es zu vergrößern):
Titelseite:
Impressum und Inhaltsverzeichnis:
Überschriften:
Text mit Absatz- und Zeichenformaten:
Stichwortverzeichnis (Index):
Preis und Bestellmöglichkeit

Der Preis für eine zeitlich unbefristete Lizenz beträgt € 19 plus Mehrwertsteuer.
Sie können eine Lizenz hier erwerben.
 

Beratung

Wenn Sie nicht die Zeit haben, selbst ein Experte für Technische Dokumentation zu werden, helfe ich Ihnen gerne persönlich. Ich berate Sie kompetent, wie Sie Benutzerhandbücher, Online-Hilfen und andere Formen Technischer Dokumentation effizient erstellen und qualitativ optimieren.

Häufig haben meine Kunden bereits eine erste Version ihrer Dokumentation geschrieben. Da sich die Produkte jedoch weiterentwickelt haben, muss diese Dokumentation jetzt überarbeitet werden. In diesem Fall analysiere ich die bestehenden Dokumente und erarbeite Verbesserungsvorschläge.

Falls erforderlich, kann ich die notwendigen Änderungen anschließend auch einarbeiten, oder ich kann Sie dabei unterstützen.

Andere Beratungsprojekte konzentrieren sich auf die technische Ebene: Wenn Sie nach Autorenwerkzeugen suchen, die das Erstellen Ihrer Technischen Dokumentation einfach und effizient machen, berate ich Sie objektiv bei der Auswahl - frei von Verkaufsinteressen an einem speziellen Redaktionssystem. Insbesondere habe ich langjährige Erfahrung und umfassende Marktkenntnisse im Bereich Help-Authoring-Tools und Single-Source-Publishing-Lösungen. Diese Programme können sowohl gedruckte Handbücher (PDF) als auch Online-Hilfen (HTML, CHM) aus derselben gemeinsamen Textquelle heraus generieren.

Falls erforderlich, kann ich das gewählte System auch für Sie einrichten und professionelle Formatvorlagen (Templates) erstellen, die die Inhalte Ihrer Dokumente klar kommunizieren und für die Autoren effizient zu handhaben sind.

Schulung

Häufig werden Mitarbeiter aus der Entwicklung oder aus dem Marketing mit dem Schreiben Technischer Dokumentation betraut. Diese Personen sind zwar Experten in ihrem jeweiligen Fachgebiet, nicht unbedingt jedoch auch erfahrene Technische Redakteure. Das führt dazu, dass Benutzer oft schlicht nicht verstehen, was ihnen diese Personen in ihren Texten sagen möchten. Noch schlimmer: Die entstehenden Dokumente sind häufig so unglücklich aufgebaut, dass die Leser die betreffenden Informationen erst gar nicht finden.

Meine Schulungen helfen Ihnen, Ihre Texte einfach und verständlich zu formulieren. Außerdem lernen Sie, Strukturen zu finden, die die Leser direkt zu den jeweils benötigten Informationen führen.

Welche Inhalte eine Schulung jeweils genau umfasst, hängt von Ihrem spezifischen Bedarf und vom Vorwissen der Teilnehmer ab. Da die Schulungen im Normalfall Inhouse-Schulungen bei Ihnen vor Ort sind, können wir unmittelbar an Ihren eigenen Dokumenten arbeiten. Das macht die Schulungen äußerst praxisnah. Die Teilnehmer erhalten auf diese Weise nicht nur allgemeingültige Empfehlungen, sondern ganz konkrete Verbesserungsvorschläge für ihre eigene Arbeit.

Optional kann ich Sie auch nach der Schulung noch einige Zeit lang unterstützend weiterbegleiten. Zum Beispiel kann ich in der Anfangsphase Feedback und Verbesserungsvorschläge liefern und auftretende Fragen beantworten.
 

Über mich

Mein Name ist Marc Achtelig. Seit mehr als 20 Jahren konzipiere und schreibe ich hauptberuflich Benutzerhandbücher, Online-Hilfen und andere Formen Technischer Dokumentation. Seit 2004 betreibe ich mein eigenes Ingenieurbüro für Technische Kommunikation.

Neben meinen Büchern gebe ich mein Wissen und meine Erfahrung auch in Form von Schulungen, Vorträgen und Fachartikeln weiter. Bei Interesse finden Sie hier eine Liste aller meiner Veröffentlichungen.

Ich bin Mitglied der tekom, dem deutschen Fachverband für Technische Kommunikation.

Übrigens: Von der Ausbildung her bin ich Ingenieur und Wirtschaftsingenieur. Auch beim Dokumentieren komplexer Produkte verstehe ich also, über was ich schreibe. Naja, zumindest meistens ;-)
 
Ich freue mich auf Ihre Nachricht …

Marc Achtelig
Dipl.-Ing.(FH), Dipl.-Wirtschaftsing.(FH)

Ingenieurbüro für Technische Kommunikation

Goethestr. 24
90513 Zirndorf bei Nürnberg
Deutschland

E-Mail:  info@best-practices-technische-dokumentation.de
Tel.:  +49 (0)911/60046-659
Fax:  +49 (0)911/60046-863