Stehen Sie vor der Aufgabe, für eines Ihrer Produkte eine Technische Dokumentation erstellen oder verbessern zu „dürfen“? Soll Ihr Benutzerhandbuch oder Ihre Online-Hilfe richtig gut werden, Sie haben aber nicht die Zeit zum Studium dutzender allumfassender Fachbücher?

„Basiswissen Technische Dokumentation“ liefert Ihnen eine übersichtliche Zusammenfassung der Regeln und Prinzipien, auf die es wirklich ankommt. Wenn Sie den gegebenen Empfehlungen folgen, wird dies die Qualität Ihrer Dokumente spürbar verbessern – bei minimalem Aufwand.

Das Buch bietet in der Praxis leicht umsetzbare Tipps und zahlreiche einprägsame Beispiele – frei von theoretischen Abhandlungen und linguistischen Fachbegriffen.

Das Buch ist dabei selbst Vorbild für das, was auch Sie erreichen müssen. Es enthält viele wertvolle Informationen auf so wenig Seiten wie möglich – in einfacher und verständlicher Form.

Diese Ausgabe des Buchs ist zweisprachig: Englisch + Deutsch. Alle global relevanten Themen werden in englischer Sprache behandelt. Themen und Hinweise, die speziell die deutsche Sprache und Dokumente für den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben.

Inhalt:

Prinzipien der Strukturierung, z. B. Bilden von Kapiteln und Hilfethemen, Wählen der richtigen Überschriften und Festlegen der bestmöglichen Informationsreihenfolge
Grundlagen zu Layout und Formatierung
Allgemeine Regeln zum Thema verständliches Schreiben
Besondere Schreibregeln auf Abschnittsebene
Besondere Schreibregeln auf Satzebene
Besondere Schreibregeln auf Wortebene
FAQ zu Grammatik und Wortwahl