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. Zielgruppe: Entwickler, Marketing-Verantwortliche, Produktmanager.

Selbst die besten Informationen sind wertlos, wenn Benutzer sie nicht finden. Eine benutzerfreundliche Struktur und Navigation zu schaffen, ist mindestens ebenso wichtig, wie gut geschriebene Inhalte. Allerdings ist die Strukturierung einer Technischen Dokumentation 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 das ist, was Ihre Kunden bevorzugen, liegen Sie falsch. Wenn Sie denken, dass alle Ihre Informationen wichtig sind, liegen Sie auch falsch. Dieses Buch zeigt Ihnen, wie Sie Ihre Dokumente so strukturieren, indexieren und verlinken, dass Leser die enthaltenen Informationen auch tats chlich finden. Das Buch 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: Allgemeine Strukturierungs-Prinzipien, die allen Gliederungsentscheidungen zugrunde liegen. Medien ausw hlen: Sollten Sie ein gedrucktes oder druckbares Benutzerhandbuch (PDF) bevorzugen, eine Online-Hilfe oder beides? Welche Informationen kommen ins Handbuch, welche in die Hilfe? Welches Hilfe-Format sollten Sie verwenden? Sind kontextsensitive Hilfeaufrufe m glich? Sollten Sie interaktive Funktionen einbauen? Ist es sinnvoll, Social Features" zur Beteiligung und Vernetzung der Benutzer vorzusehen? Dokumente planen: Sollten Sie alle Informationen in ein einziges Dokument aufnehmen oder lieber mehrere Handb cher f r unterschiedliche Anwendungszwecke und Benutzergruppen erstellen? Wie sollten Sie Ihre Dokumente nennen? Hauptabschnitte innerhalb der Dokumente planen: Aus welchen Hauptabschnitten sollte Ihr Dokument bestehen? Gibt es bestimmte Standardabschnitte, die Sie nicht vergessen d rfen? Einzelthemen planen: Welche Informationstypen ben tigt Ihre Zielgruppe? Wie sollten Sie die einzelnen Kapitel oder Hilfe-Topics in Ihren Dokumenten aufbauen und benennen? Reihenfolge der Abschnitte und Themen planen: Wie sollten Sie die Abschnitte, Kapitel und Themen in Ihren Dokumenten anordnen? Was kommt zuerst, was kommt sp ter? Navigation planen: Welche Navigationsmittel sollten Sie in gedruckten Dokumenten vorsehen, welche Navigationsmittel in Online-Hilfen? Wo sollten Sie Links und Querverweise anbieten, und wo nicht? Zielgruppe: Technische Redakteure, Entwickler, Marketing-Verantwortliche, Produktmanager

sthetik ist nicht das Einzige, was Sie beim Erstellen einer Formatvorlage anstreben sollten. In Technischer Dokumentation, wie Benutzerhandb chern und Online-Hilfen, sind Usability," Lesbarkeit und Einfachheit mindestens ebenso wichtig. Das Design soll das Auge des Betrachters erfreuen, gleichzeitig muss es die Inhalte klar und bersichtlich kommunizieren. Absatzformate und Zeichenformate sollten beim Schreiben des Dokuments einfach zu handhaben sein. Der Layout-Prozess sollte so weit wie m glich automatisiert werden. Da Technische Dokumentation in der Regel h ufig aktualisiert wird, ist ein automatisierter Layout-Prozess hier wesentlich wichtiger als in anderen Buchtypen. Wenn Sie z. B. einen neuen Absatz in ein Dokument einf gen, darf dies nicht dazu f hren, dass Sie alle nachfolgenden Seitenwechsel von Hand neu optimieren m ssen - ganz zu schweigen von Seitenzahlen, Querverweisen, dem Inhaltsverzeichnis und dem Index. Absatzformate und Zeichenformate zu definieren, die beim Erstellen und Pflegen eines Dokuments effizient anwendbar sind, erfordert viel Erfahrung als Technischer Redakteur. Die in diesem Buch gegebenen Empfehlungen sind die Essenz dieser Erfahrung. Alle Kapitel enthalten zahlreiche Beispiele, die Sie als Inspiration und Ausgangspunkt f r Ihre eigenen Designs nutzen k nnen. 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: Grundlagen zum Layout; Satzspiegel festlegen; Schriftarten und Abst nde w hlen; Manuelle Formatierungen vermeiden; Semantische Formate vorsehen; Formate hierarchisch organisieren; Empfohlene Bildschirm-Layouts; Empfohlene Seiten-Layouts; Empfohlene Tabellen-Designs; Empfohlene Absatzformate; Empfohlene Zeichenformate. Zielgruppe: Technische Redakteure, Entwickler, Marketing-Verantwortliche, Produktmanager, Grafiker und Mediengestalter.

Benutzer wollen leicht lesbare Handb cher mit kurzen S tzen, einfachen W rtern und unmissverst ndlichen Anleitungen. Leider ist es wesentlich schwieriger eine einfache Anleitung zu schreiben als eine, die nur ein Experte versteht. Das Schreiben komplizierter Texte ist einfach - das Schreiben einfacher Texte ist kompliziert. Dieses Buch zeigt Ihnen, wie Sie einfache Texte schreiben, die Benutzer unterst tzen, statt sie zu berfordern. Da es in dem Buch um verst ndliche Inhalte geht, vermittelt das Buch auch seine eigenen Inhalte verst ndlich und ohne Umschweife. Das Buch ist garantiert frei von langatmiger Theorie und hochtrabendem Fachvokabular. Es liefert klare Empfehlungen und pr gnante, einpr gsame Beispiele, die Sie leicht auf Ihre eigene Arbeit anwenden k nnen. 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 unterst tzen zu k nnen, ist diese Ausgabe des Buchs zweisprachig aufgebaut: Englisch + Deutsch. 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. Themen und Hinweise, die speziell die deutsche Sprache und Dokumente f r den deutschen Sprachraum betreffen, sind in deutscher Sprache beschrieben. Inhalt: Allgemeine Schreibtechniken, die Ihre Texte einfach, bersichtlich und leicht verst ndlich machen; Auf Kapitel-Ebene: Regeln zum Erstellen der grundlegenden Informationstypen Concept," Task" und Reference"; Auf Absatzebene: Regeln zum Schreiben der textbildenden Standardelemente, wie berschriften, Zwischen berschriften, schrittweise Anleitungen, Aufz hlungen, Tabellen, Warnhinweise, sonstige Hinweise, Tipps, Beispiele, Querverweise und Links; Auf Satzebene: Regeln zum Bau verst ndlicher, eindeutiger S tze; Auf Wortebene: Tipps zur Verwendung einfacher W rter; FAQ zu Rechtschreibung und Zeichensetzung; FAQ zu Wortwahl und Grammatik; Standardisierte Begriffe und Formulierungen. Zielgruppe: Technische Redakteure, Entwickler, Marketing-Verantwortliche, Produktmanager.

Eine Technische Dokumentation zu bersetzen, unterscheidet sich grundlegend vom bersetzen anderer Textsorten. Wenn Sie ein Benutzerhandbuch oder eine Online-Hilfe in derselben Art und Weise bersetzen, wie Sie dies von anderen Dokumenttypen gewohnt sind, werden Ihre Auftraggeber (meist Technische Redakteure) von den Ergebnissen wenig begeistert sein. Zum Beispiel ist ein abwechslungsreicher Sprachstil, der einen Roman oder eine Verkaufsbrosch re erst so richtig lebendig und interessant macht, genau das, was in Benutzerhandb chern zu massiven Verst ndnisproblemen f hrt. Wenn Sie Technische Dokumentation bersetzen, sollten Sie verstehen, nach welchen Prinzipien Ihre Auftraggeber die Dokumente im Hinblick auf optimale Verst ndlichkeit aufgebaut haben. Nur dann kann auch Ihre bersetzung denselben Prinzipien gerecht werden. Dieses Buch zeigt Ihnen die grundlegenden Schreibregeln, die jeder Technische Redakteur befolgt. Wenn Sie dieselben Regeln auf Ihre bersetzung anwenden, ist die Zufriedenheit sowohl Ihrer Auftraggeber als auch der sp teren Leser so gut wie garantiert. Diese Ausgabe des Buchs ist zweisprachig: Deutsch + Englisch. Alle Themen, die prim r f r die englische Sprache oder universell gelten, sind in englischer Sprache verfasst. Themen, die speziell die deutsche Sprache betreffen, sind in deutscher Sprache beschrieben. Zielgruppe: bersetzer