In diesem Kapitel, Buchdesign bezeichnet die Inhalte, den Stil, das Format, das Design und die Reihenfolge der verschiedenen typischen Komponenten eines Buches. "Komponenten" bezieht sich hier auf tatsächliche Abschnitte oder Seiten eines Buches, wie die Ausgabevermerke, das Vorwort, das Register oder den Vorder- oder Rückumschlag. In der Seiten-Design Kapitel, der Begriff Element bezieht sich auf Dinge, die praktisch überall in einem Buch mehrfach auftreten können, wie Überschriften, Fußzeilen, Tabellen, Illustrationen, Listen, Hinweise, Hervorhebungen usw.

Die folgende Übersicht bietet einen Einblick in die typischen Komponenten eines gedruckten Fachbuchs sowie in die typischen Inhalte, Formate, Stile und Abfolgen dieser Komponenten. Sicherlich wird kein einzelnes Benutzerhandbuch, technisches Referenzhandbuch, Schnellreferenzdokument oder ein anderes solches Dokument alle diese Komponenten genau in der Art und Weise darstellen, wie Sie sie gleich lesen werden. Stattdessen wird diese Übersicht einen Überblick über die Möglichkeiten geben—sagen wir, die Bandbreite der Möglichkeiten.

Hinweis: Derzeit haben wir nur ein Beispiel. Benutzerhandbuch entwickelt in FrameMaker und dann als PDF ausgegeben. Es fehlt ein Glossar, aber alle anderen Teile eines typischen Benutzerhandbuchs sind vorhanden. (Ich kann dieses "d" in "Filepad" nicht herausfinden!) Beachten Sie, dass es einige der unten aufgeführten Schrift- und Randanforderungen nicht verwendet.

Bevor Sie mit dem Lesen des Folgenden beginnen, holen Sie sich eine Reihe von Hardware- und Softwarebüchern, damit Sie deren Inhalt, Stil, Format und Sequenzierung mit dem hier Diskutierten vergleichen können.

Für noch mehr Details als die, die Sie hier sehen, konsultieren Sie diese beiden Standardressourcen der Branche:

Sie können Beispiele für diese Buchkomponenten in Technische Dokumentation Design.

Vorder- und Rückseite des Covers

Produktdokumente für zahlende Kunden haben normalerweise schön gestaltete Umschläge, selbst wenn das Innere des Buches qualitativ minderwertig ist. Auf dem Umschlag sieht man typischerweise einige oder alle der folgenden Punkte:

Es kann herausfordernd sein, ein gutes Format für den Firmennamen, den Produktnamen und den Buchtitel zu finden. Manchmal kann das ganze Absätze Text ausmachen! Unternehmen sind sich oft nicht einig, ob Versionen und Veröffentlichungsnummern auf den Vorderseiten angegeben werden sollten—die einen tun es; die anderen nicht. Fast immer sieht man jedoch die Plattform angegeben—ob das Produkt für den Macintosh, den PC, UNIX usw. ist.

Der Umschlagrücken von gedruckten Benutzerhandbüchern und Anleitungen ist normalerweise sehr einfach. Typischerweise enthält er die Buchbestellnummer, den Namen des Unternehmens mit den entsprechenden Markensymbolen, ein Copyright-Symbol und eine Formulierung zum Eigentum des Buches sowie einen Hinweis darauf, in welchem Land das Buch gedruckt wurde. Auf dem Umschlagrücken finden Sie auch Barcodes. Überprüfen Sie, ob Ihre Software einen Barcode generieren kann—Sie rufen einfach das Barcode-Tool auf und geben die Buchbestellnummer ein, und das Tool generiert den Barcode.

Titelseite

Die Titelseite ist typischerweise eine Duplikat des Vordercovers, jedoch mit bestimmten Elementen weggelassen. Typischerweise weggelassen sind die Grafiken, Unternehmens- oder Produktlogos und Slogans. Einige technische Publikationen lassen die Titelseite ganz weg, da die scheinbar unnötige Duplizierung. (Und bei einer Druckauflage von 20.000 Exemplaren bedeutet eine einzige Seite viel!)

Editionshinweis

Der Editionshinweis ist typischerweise die erste Regeltextstelle in einer technischen Veröffentlichung, obwohl er normalerweise in kleinerer Schriftart verfasst ist. Er befindet sich auf der Rückseite der Titelseite. Wenn der technische Verlag den Ansatz "lean-and-green" verfolgt und die Titelseite entfernt, erscheint der Editionshinweis auf der Rückseite des Vordercovers.

Niemand liest gerne das Kleingedruckte, aber schauen Sie sich die Aussagen an, die typischerweise in einer Ausgabenbenachrichtigung enthalten sind:

Haftungsausschlüsse

Siehe den Abschnitt über Ausgabevermerke, wo Haftungsausschlüsse normalerweise versteckt sind. Wenn ein Produkt oder seine Veröffentlichung eine ganz separate Seite für seine Haftungsausschlüsse benötigt, kaufe ich es nicht!

Marken

Obwohl viele Unternehmen ihre eigenen und die Marken anderer Unternehmen auflisten in der Ausgabebekanntmachung, einige ziehen es vor, sie auf einer separaten Seite, direkt nach dem Hinweisteil zur Ausgabe, aufzulisten. Diese Platzierungsentscheidungen liegen fast ausschließlich im Zuständigkeitsbereich der Unternehmensanwälte; als Autor müssen Sie möglicherweise zustimmen, egal wie schlecht die Entscheidung in Bezug auf Buchdesign oder Schreibstil ist. Denken Sie daran, dass Sie nur die markenrechtlich geschützten Produktnamen auflisten, die in diesem speziellen Buch vorkommen.

Sie werden feststellen, dass einige Publikationen extreme Maßnahmen mit Markenrechten ergreifen: Sie setzen ein Sternchen oder eine Fußnote bei der ersten oder sogar bei jeder Erwähnung eines markenrechtlich geschützten Produktnamens. Aber auch hier sind dies Vorgaben der Unternehmensanwälte, denen sich technische Redakteure leider fügen müssen.

Garantiebedingungen

Mehr rechtliche Informationen. Dies sind die "Garantien", die das Unternehmen in Bezug auf sein Produkt anbieten wird. Manchmal werden sie im vorderen Teil des Buches veröffentlicht; aber von einem buchgestalterischen Standpunkt aus gesehen, ist es angemessener, sie auf einer separaten Karte zu drucken und in die Umhüllung des Buches oder des Produkts einzufügen. Wiederum, wie bei den Auflagenhinweisen, ist dies ein Text, den Sie einfach als "Standardtext" verwenden und an der richtigen Stelle im Buch positionieren.

Sie sollten jedoch wissen, dass Unternehmen manchmal mehrere Versionen von Herausgeberhinweisen, Sicherheitsmitteilungen, Garantien, Kommunikationsaussagen und ähnlichem führen. Als Schriftsteller müssen Sie sicherstellen, dass Sie die richtige Version verwenden (und beim Herausfinden, welche korrekt ist, haben Sie die Möglichkeit, viele neue Menschen im Unternehmen kennenzulernen!). Und was auch immer Sie tun, ändern Sie nicht den Text dieser Standardformulierungen, egal wie schlecht sie geschrieben sind. Änderungen müssen in der Regel von den Unternehmensanwälten genehmigt werden (die dies normalerweise widerwillig tun und nur nach vielen Anstrengungen Ihrerseits und nachdem viel Zeit vergangen ist).

Sicherheitswarnungen

Hardwareprodukte haben typischerweise einen Abschnitt mit Sicherheitshinweisen am Anfang ihrer Bücher. Diese können beispielsweise als Unterabschnitt des Vorworts oder als separater Abschnitt in ihrer eigenen Form auftreten. Diese Abschnitte fassen typischerweise alle Gefahren-, Warn- und Vorsichtshinweise zusammen, die im gesamten Buch vorkommen, und ordnen sie in irgendeiner logischen Weise an. Aber selbst mit diesem vorn platzierten Hinweis befinden sich die einzelnen Hinweise immer noch an den Stellen, an denen sie relevant sind. (Für weitere Informationen siehe besondere Hinweise.)

Kommunikationsäußerungen

Hardwarebücher benötigen ebenfalls Kommunikationsaussagen, wie sie von den Regierungen der Länder, in die diese Produkte versandt werden, vorgeschrieben sind. In den USA verlangt die FCC bestimmte Kommunikationsaussagen, abhängig von der „Klasse“ des Hardwareprodukts. Als Autor müssen Sie darauf achten, die richtige Kommunikationsaussage für das Produkt, das Sie dokumentieren—zu verwenden und die Aussage in keiner Weise zu bearbeiten (heilige Rechtsworte!).

Inhaltsverzeichnis

Das Inhaltsverzeichnis (IV) enthält normalerweise mindestens eine zweite Detailstufe (die Überschriften 1 im tatsächlichen Text), damit die Leser genauer finden, was sie benötigen. Autoren, Lektoren und Buchdesigner streiten oft über die Reihenfolge des Inhaltsverzeichnisses. In Bezug auf die Benutzerfreundlichkeit ist es viel besser, das Inhaltsverzeichnis so nah wie möglich am Anfang des Buches zu platzieren, wenn nicht sogar direkt am Anfang des Buches. In rechtlichen Belangen jedoch machen sich die Menschen Sorgen, dass all diese Kommunikationsaussagen, Garantien, Urheberrechte, Marken und Sicherheitswarnungen zuerst kommen sollten. In den Fällen, in denen die Benutzerfreundlichkeit überwiegt, nutzen Bücher jede Taktik, um dieses juristische Material aus dem vorderen Bereich zu entfernen: Garantien werden auf separate Karten gedruckt und zusammen mit dem Buch oder Produkt in Folie eingeschweißt; Garantien, Kommunikationsaussagen, Marken und ähnliches können in Anhänge verschoben werden.

Probleme bei der Erstellung eines ansprechend formatierten Inhaltsverzeichnisses? Siehe Erstellen Sie ein professionell aussehendes Inhaltsverzeichnis

Abbildungsliste

Technische Handbücher für normale Benutzer enthalten normalerweise keine Abbildungsverzeichnisse. Tatsächlich haben die Abbildungen selbst typischerweise keine vollständigen Abbildungsüberschriften. Aber das bedeutet nicht, dass ein Abbildungsverzeichnis keinen Platz in technischen Handbüchern hat. Es hängt alles vom Leser und den Bedürfnissen des Lesers sowie vom Inhalt des Buches ab. Wenn das Buch Tabellen, Illustrationen, Diagramme, Grafiken und dergleichen enthält, die die Leser direkt finden möchten, ist ein Abbildungsverzeichnis angebracht.

Vorwort

Die Funktion des Vorworts besteht darin, die Leser auf das Lesen des Buches vorzubereiten. Dies geschieht durch:

In der traditionellen Buchveröffentlichung steht das Vorwort vor dem Inhaltsverzeichnis; aber wie bereits zuvor diskutiert in der inhaltsverzeichnis In diesem Abschnitt möchten die technischen Verleger, dass das Inhaltsverzeichnis aus Usability-Gründen früher im Buch erscheint.

Körperkapitel

Oh ja, und es gibt tatsächlich Text in diesen Büchern—es besteht nicht nur aus Vorworten! Nicht viel mehr zu sagen, außer dass die meisten technischen Bücher Kapitel oder Abschnitte haben und in einigen Fällen auch Teile. Siehe das Kapitel über Seitenlayout für Format-, Stil- und Designfragen für Elemente wie Kopfzeilen, Fußzeilen, Überschriften, Listen, Hinweise, Tabellen, Grafiken, Querverweise und Hervorhebungen.

Anhänge

Wie Sie wissen, sind Anhänge für Material, das einfach nicht in den Hauptteil eines Buches passt, aber auch nicht aus dem Buch weggelassen werden kann. Anhänge sind oft der Ort für große, unhandliche Tabellen. Einige technische Veröffentlichungen haben Dinge wie Garantien in den Anhängen. In Bezug auf das Format ist ein Anhang genau wie ein Kapitel—, mit dem Unterschied, dass er "Anhang A" oder ähnlich benannt ist und die Kopf- und Fußzeilen dieser anderen Nummerierungs- und Namenskonvention (A-1, A-2 und so weiter für Seiten im Anhang A) entsprechen.

Glossar

Einige technische Publikationen enthalten einen Abschnitt mit Fachbegriffen und deren Definitionen. Beachten Sie, dass die meisten Glossare ein zweispaltiges Layout verwenden. Typischerweise bilden jeder Begriff und seine Definition einen separaten Absatz, wobei der Begriff in Kleinbuchstaben (es sei denn, es handelt sich um einen Eigennamen) und in Fettdruck dargestellt wird, gefolgt von einem Punkt, dann die Definition in regulärem Schriftbild. Beachten Sie auch, dass Definitionen typischerweise keine vollständigen Sätze sind. Gute Glossar-Definitionen sollten die Technik der formalen Satzdefinition verwenden, wie beschrieben in der Definitionskapitel diesem Online-Text. Mehrere Definitionen werden typischerweise durch arabische Zahlen in Klammern identifiziert. Glossarabschnitte enthalten ebenfalls Sehen Verweise auf bevorzugte Begriffe und Siehe auch Bezugnahmen auf verwandte Begriffe.

Index

Indexe sind typischerweise ebenfalls zweispaltig und enthalten auch Siehe Referenzen zu bevorzugten Begriffen und Siehe auch Verweise auf verwandte Begriffe. Siehe das Kapitel über indizierung für Prozesse und Richtlinien zur Erstellung guter Indizes.

Leser-Antwort-Formular

Vor dem Aufkommen des Internets und der sozialen Medien enthielten einige Fachpublikationen ein Formular in Papierform, um den Lesern zu ermöglichen, Kommentare, Fragen und Bewertungen des Buches einzusenden. Natürlich stellt sich heraus, dass diese Formulare öfter Beschwerden über fehlerhafte Funktionen des Produkts hervorrufen, das im Buch dokumentiert wird. Mit dem Aufstieg des Internets sind diese Formulare online gegangen, und Bücher verweisen nur auf ihren Standort im Internet.

Buchgestaltung und -layout

Typischerweise sind Benutzerhandbücher und -anleitungen, die von Hardware- und Softwareherstellern erstellt werden, eher einfach und spartanisch gestaltet. High-Tech-Unternehmen entwickeln manchmal alle neun Monate neue Versionen und Releases ihrer Produkte. In diesem Zusammenhang ist ein anspruchsvolles Design einfach unpraktisch. Hier sind einige typische Layout- und Designelemente, die Sie sehen werden:

Hinweis: Dies schließt die Diskussion über Printbücher ab. Komponenten. Um diesen Überblick über das Design von gedruckten Büchern abzuschließen, siehe das Kapitel über Seitenlayout, das abdeckt Elemente wie Kopf- und Fußzeilen, Überschriften, Listen, besondere Hinweise, Tabellen, Grafiken, Hervorhebungen, Querverweise und mehr.

Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort.