Bitte hier klicken, um zu helfen David McMurrey Bezahlen Sie für Webhosting:
Spenden Sie jeden kleinen Betrag, den Sie können.
Online-Technisches Schreiben bleibt kostenlos.
Diese Seite wird gerade repariert.
Ein Benutzerhandbuch ist einTechdokument, das erklärt, wie man häufige Aufgaben als Benutzer eines Produkts durchführt. Häufig Aufgaben sind die Aktionen, die der Benutzer in der Lage sein muss, auszuführen. Die Benutzer ist auf einem Niveau von Wissen und Erfahrung, das vom Produkt beabsichtigt ist. Einige Produkte haben Basisbenutzer und fortgeschrittene Benutzer—ein Benutzerhandbuch kann eine dieser Bedürfnisse oder beide erfüllen. Denken Sie an eine Mikrowelle: Sie kann einen Basisbenutzer haben, und das ist es. Andererseits kann ein Grafikdesign-Produkt sowohl Basisbenutzer als auch fortgeschrittene Benutzer haben.
NotebookLLM-generierte Infografik dieses Kapitels
In diesem Kapitel, Buchdesign bedeutet den Inhalt, den Stil, das Format, das Design und die Reihenfolge der verschiedenen typischen Bestandteile eines Buches. "Bestandteile" bezieht sich hier auf tatsächliche Abschnitte oder Seiten eines Buches wie die Auflagenmitteilung, das Vorwort, das Inhaltsverzeichnis oder den vorderen oder hinteren Umschlag. In der Seitenlayout Kapitel, der Begriff Element bezieht sich auf Dinge, die mehrfach praktisch überall in einem Buch vorkommen können, wie z. B. Überschriften, Fußnoten, Tabellen, Illustrationen, Listen, Hinweise, Hervorhebungen usw.
Die folgende Übersicht gibt einen Überblick über die typischen Komponenten eines gedruckten Fachbuchs sowie über den typischen Inhalt, das Format, den Stil und die Reihenfolge dieser Komponenten. Sicherlich hätte kein einzelnes Benutzerhandbuch, technisches Referenzhandbuch, Schnellreferenzdokument oder ein anderes solches Dokument tatsächlich all diese Komponenten genau so gestaltet und angeordnet, wie Sie es gleich lesen werden. Diese Übersicht wird stattdessen einen Überblick über die Möglichkeiten geben – sagen wir den Spielraum der Möglichkeiten.
Hinweis: Derzeit haben wir nur ein Beispiel. Benutzerhandbuch in FrameMaker entwickelt und dann als PDF ausgegeben. Es fehlt ein Glossar, aber alle anderen Teile eines typischen Benutzerhandbuchs sind vorhanden. (Ich kann das "d" in "Filepad" nicht herausfinden!) Bitte beachten Sie, dass es einige der unten aufgeführten Schrift- und Randanforderungen nicht erfüllt.
Bevor du mit dem Lesen des Folgenden beginnst, schnapp dir eine Reihe von Hardware- und Softwarebüchern, damit du deren Inhalt, Stil, Format und Sequenzierung mit dem, was hier besprochen wird, vergleichen kannst.
Für noch mehr Details als die, die Sie hier sehen, konsultieren Sie bitte diese beiden standardmäßigen Branchenressourcen:
- Sun Technische Publikationen. Lies mich zuerst! Jede aktuelle Ausgabe. Prentice Hall.
- Microsoft Corporation. Microsoft-Handbuch für den Stil technischer Publikationen. Jede aktuelle Ausgabe. Microsoft Press.
Sie können Beispiele für diese Buchkomponenten in Techdoc-Design.
Vorder- und Rückseite der Umschläge
Produktunterlagen für zahlende Kunden haben normalerweise ansprechend gestaltete Frontcover, selbst wenn das Innere des Buches qualitativ minderwertig ist. Auf dem Frontcover sieht man typischerweise einige oder alle der folgenden Elemente:
- Firmenname
- Produktname
- Produktplattform oder Betriebssystem
- Produktversion und Versionsnummern
- Buchtitel
- Unternehmens- oder Produktlogos
- Marken-Symbole
- Kunstwerk
- Buchbestellnummer
- Unternehmens- oder Produkt-Slogan
Es kann eine Herausforderung sein, ein gutes Format für den Firmennamen, den Produktnamen und den Buchtitel zu finden. Manchmal können diese einen ganzen Absatz Text ausmachen! Unternehmen sind sich oft uneinig, ob Versions- und Veröffentlichungsnummern auf den Vorderseiten angegeben werden—manche tun es; manche tun es nicht. Fast immer wird jedoch die Plattform angegeben—ob das Produkt für den Macintosh, den PC, UNIX usw. ist.
Beispiel für eine Titelseite.
Die Rückseite von gedruckten Benutzerhandbüchern und Anleitungen ist in der Regel sehr schlicht. Typischerweise enthält sie die Bestellnummer des Buches, den Namen des Unternehmens mit entsprechenden Markensymbolen, ein Urheberrechtssymbol und Formulierungen zum Eigentum des Buches sowie eine Angabe, in welchem Land das Buch gedruckt wurde. Auf der Rückseite finden Sie auch Barcodes. Überprüfen Sie, ob Ihre Software einen Barcode generieren kann— Sie greifen einfach auf das Barcode-Utility zu, geben die Bestellnummer des Buches ein und das Utility generiert den Barcode.
Titelseite
Die Titelseite ist typischerweise eine Duplikat des Covers, jedoch mit bestimmten Elementen weggelassen. Üblicherweise weggelassen sind die Grafiken, Unternehmens- oder Produktlogos und Slogans. Einige technische Publikationen lassen die Titelseite ganz weg, weil die scheinbar unnötige Wiederholung. (Und bei einem Druck von 20.000 Exemplaren bedeutet eine einzelne Seite viel!)
Beispiel einer Titelseite.
Ausgabenhinweis
Die Editionsnotiz ist typischerweise die erste Stelle regulären Textes in einer technischen Veröffentlichung, obwohl sie in der Regel in kleinerer Schriftgröße erscheint. Sie befindet sich auf der Rückseite der Titelseite. Wenn der technische Verlag den Lean-and-Green-Ansatz verfolgt und die Titelseite eliminiert, wird die Editionsnotiz auf der Rückseite des Vordercovers erscheinen.
Niemand liest gerne das Kleingedruckte, aber werfen Sie einen Blick auf die Aussagen, die typischerweise in einer Auflagemitteilung enthalten sind:
Beispiel für eine Auszeichnungsmitteilung
Markenzeichen
Ob Sie Marken auflisten und wie Sie sie hören, liegt im Ermessen der Unternehmensanwälte. In jedem Fall listen Sie nur die markenrechtlich geschützten Produktnamen auf, die in diesem speziellen Benutzerhandbuch vorkommen.
Am häufigsten werden Marken wie folgt angegeben:
- in der Herausgebernotiz (wie die obige Illustration zeigt)
- in einem separaten Abschnitt irgendwo im Benutzerhandbuch
erwähnen Sie diese Notiz
Wenn Unternehmensanwälte möchten, dass jede Erwähnung eines markenrechtlich geschützten Produktnamens mit einem Sternchen oder einer Fußnote gekennzeichnet wird, versuche, sie von diesem Seitenlayout-Fiasko abzubringen. Den Text mit Sternchen oder Fußnotennummern zu verschandeln, lenkt die Leser ab.
Garantieen
Garantiebedingungen begleiten physische Hardwareprodukte—nicht Software. Unternehmensanwälte übernehmen die Verantwortung für die Garantieformulierung und -formatierung. Wenn Sie ein Beispielbenutzerhandbuch oder Buch für Ihr Portfolio erstellen, können Sie dieses anonyme "Garantiebeispiel" verwenden.Popup um zu zeigen, dass Sie sich bewusst sind, dass Garantien enthalten sein müssen.
Softwaregarantien?Sicherheitsinformationen
Hardwareprodukte haben typischerweise einen Abschnitt mit Sicherheitsmeldungen am Anfang ihrer Bücher. Diese können beispielsweise als Unterabschnitt des Vorworts oder als eigener, separater Abschnitt auftreten. Diese Abschnitte fassen normalerweise alle Gefahr-, Warn- und Vorsichtshinweise zusammen, die im gesamten Buch vorkommen, und ordnen sie auf eine logische Weise an. Aber selbst mit dieser vorangestellten Warnung platzieren Hardwarebücher die einzelnen Hinweise an den Stellen, an denen sie gelten. (Für weitere Informationen siehe Besondere Mitteilungen.)
Kommunikationsaussagen
Hardware-Handbücher erfordern auch 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 auf keine Weise zu bearbeiten (heilige rechtliche Worte!).
Inhaltsverzeichnis
Das Inhaltsverzeichnis (IV) enthält normalerweise mindestens eine zweite Detailstufe (die Überschrift 1 im eigentlichen Text), damit die Leser gezielter finden, was sie benötigen. Autoren, Redakteure und Buchgestalter diskutieren typischerweise über die Reihenfolge des IV. In Bezug auf die Benutzerfreundlichkeit ist es viel besser, das IV so nah wie möglich am Anfang des Buches zu platzieren, wenn nicht sogar an allererster Stelle. In rechtlicher Hinsicht machen sich die Menschen jedoch Sorgen, dass all diese Kommunikationsaussagen, Garantien, Urheberrechte, Marken und Sicherheitshinweise zuerst kommen sollten. In den Fällen, in denen die Benutzerfreundlichkeit überwiegt, nutzen Bücher jede Taktik, um dieses rechtliche Material aus dem Vorwort zu entfernen: Garantien werden auf separaten Karten platziert und zusammen mit dem Buch oder Produkt shrink-wrapped; Garantien, Kommunikationsaussagen, Marken und ähnliches können in Anhänge verworfen werden.
Haben Sie Probleme, ein gut formatiertes Inhaltsverzeichnis zu erstellen? Siehe Erstellen Sie ein professionell aussehendes Inhaltsverzeichnis.
Abbildungsliste
Technische Handbücher für gewöhnliche Benutzer enthalten typischerweise keine Abbildungsverzeichnisse. Tatsächlich haben die Abbildungen selbst normalerweise keine vollständigen Abbildungstitel. Aber das heißt 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 Ähnliches 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. Es geschieht dies, indem:
- Charakterisierung des Inhalts und Zwecks des Buches
- Identifizieren oder sogar kurz beschreiben, welches Produkt das Buch unterstützt.
- Erklärung, für welchen Lesertyp das Buch gedacht ist.
- Die Hauptinhalte des Buches skizzieren
- spezielle Konventionen oder Terminologie, die im Buch verwendet wird
- Unterstützung und Marketingzahlen bereitzustellen sowie andere derartige Dinge.
In der traditionellen Buchveröffentlichung steht das Vorwort vor dem Inhaltsverzeichnis; aber wie zuvor besprochen in der Inhaltsverzeichnis In diesem Abschnitt möchten die technischen Verleger, dass das Inhaltsverzeichnis aus Usability-Gründen früher im Buch erscheint.
Hauptkapitel
Oh ja, und es gibt tatsächlich Text in diesen Büchern—es ist nicht nur Vorwort! Viel mehr gibt es hier nicht zu sagen, außer dass die meisten Fachbücher Kapitel oder Abschnitte haben und in einigen Fällen Teile. Siehe das Kapitel über Seitenlayout für Format-, Stil- und Designfragen von Elementen wie Kopfzeilen, Fußzeilen, Überschriften, Listen, Hinweisen, Tabellen, Grafiken, Querverweisen und Hervorhebungen.
Anhang
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 Publikationen haben Dinge wie Garantien in den Anhängen. In Bezug auf das Format ist ein Anhang genau wie ein Kapitel, außer dass er „Anhang A“ oder ähnliches genannt wird und die Kopf- und Fußzeilen mit dieser anderen Nummerierungs- und Benennungskonvention übereinstimmen (A-1, A-2 und so weiter für Seiten im Anhang A).
Glossar
Einige technische Publikationen enthalten einen Abschnitt mit Fachbegriffen und deren Definitionen. Beachten Sie, dass die meisten Glossare ein zweiseitiges Layout verwenden. Typischerweise bilden jeder Begriff und seine Definition einen separaten Absatz, wobei der Begriff kleingeschrieben (es sei denn, es handelt sich um einen Eigennamen) und fett gedruckt ist, gefolgt von einem Punkt, dann die Definition in regulärem Roman. Beachten Sie auch, dass Definitionen in der Regel keine vollständigen Sätze sind. Gute Glossarbegriffe 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. Glossarabsätze enthalten ebenfalls Sehen Verweise auf bevorzugte Begriffe und Siehe auch Referenzen zu verwandten Begriffen.
Index
Indizes sind typischerweise ebenfalls zweispaltig und enthalten auch Sehen Verweise auf bevorzugte Begriffe und Siehe auch Hinweise auf verwandte Begriffe. Siehe das Kapitel über Indizierung für Prozesse und Richtlinien zur Erstellung guter Indizes.
Leser-Reaktions-Formular
Vor dem Aufstieg des Internets und der sozialen Medien enthielten einige technische Publikationen ein Formular in Papierform, um den Lesern zu ermöglichen, Kommentare, Fragen und Bewertungen des Buches einzureichen. Natürlich stellt sich heraus, dass diese Formulare häufiger 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 noch auf ihren Standort im Internet.
Buchdesign und Layout
Typischerweise sind Benutzerhandbücher und Anleitungen, die von Hardware- und Softwareherstellern erstellt werden, in einer eher nüchternen und kargen Weise gestaltet. Hochtechnologieunternehmen entwickeln manchmal alle neun Monate neue Versionen und Veröffentlichungen ihres Produkts. In diesem Zusammenhang ist eine ausgeklügelte Gestaltung einfach nicht praktikabel. Hier sind einige der typischen Layout- und Designmerkmale, die Sie sehen werden:
- Die Seitengröße wird oft durch Verpackungsüberlegungen sowie durch gängige Seitengrößen bestimmt, die bei Druckereien verfügbar sind. Wenn die Seitengröße keine Einschränkung ist, verwenden einige Unternehmen die 8,5 × 11-Zoll-Seitengröße — was die Produktion für Schriftsteller erheblich erleichtert.
- Seiten sind typischerweise mit abwechselnd rechten und linken Seiten gestaltet. Die Fußzeile für die linke (gerade) Seite beginnt mit der Seitenzahl und endet mit dem Titel des Buches. Die Fußzeile für die rechte (ungerade) Seite beginnt mit dem Titel des Kapitels und endet mit der Seitenzahl.
- Die Praxis ist gemischt, ob die Seitenzahlen durchgehend im gesamten Buch oder nach Kapiteln nummeriert sind.
- Es sei denn, die Seiten sind ziemlich klein, ist das hängende Kopfdesign von Überschriften im Verhältnis zu Seiten in technischen Handbüchern recht verbreitet. Der hängende Einzug beträgt normalerweise ein bis anderthalb Zoll.
- Schriftarten sind oft 12-Punkt Times New Roman für Fließtext und Arial für Überschriften. Es werden Standardzeilenabstände und Wortabstände verwendet. Siehe das Kapitel über hervorheben für andere typografische Probleme.
- Die Ränder sind recht standardmäßig, ein bis zwei Zoll rundherum. Typischerweise wird auf den inneren Rändern ein zusätzliches halbes Zoll verwendet, um die Bindung zu ermöglichen.
- Typischerweise ist Farbe nicht in diesen Handbüchern und Leitfäden verwendet, normalerweise aus Kosten- und Effizienzgründen.
Inhaltsverzeichnis
Inhaltsverzeichnis
Welches Inhaltsverzeichnis (TOC) Format Sie auch verwenden, dies sind die gängigen Standards:
- Nur die Startseitennummer. Obwohl einige automatische Inhaltsverzeichnis-Generatoren den Seitenbereich anzeigen, ist die Norm nur die erste Seitenzahl.
- Ebenen der Überschriften, die einbezogen werden sollen. Wie im obigen Inhaltsverzeichnis gezeigt, sollen die obersten beiden Ebenen der Überschriften angezeigt werden, es sei denn, das Benutzerhandbuch hat viele Unterüberschriften. Das Inhaltsverzeichnis sollte eine schnelle Übersicht bieten, um Informationen schnell zu finden.
- Abstand und Großschreibung. Beachten Sie, wie die Textelemente im Inhaltsverzeichnis oben eingerückt sind. Überschriften der ersten Ebene verwenden Großbuchstaben; Überschriften der zweiten Ebene verwenden Großbuchstaben am Anfang jedes Hauptwortes; Überschriften der dritten Ebene verwenden die Satzschreibweise.
- Vertikaler Abstand. Beachten Sie, dass die ersten Ebenenabschnitte zusätzlichen Platz oben und unten haben, was die Lesbarkeit erhöht.
Je nach den Anforderungen Ihrer Organisation haben Sie zwei Formatoptionen für Inhaltsverzeichnisse (TOC):
Dieses Inhaltsverzeichnis verwendet das Dezimalnummerierungsformat für die Kapitel- und Abschnittsnummern, was in Benutzerhandbüchern üblich ist. Andere in diesem Buch verwenden nur für die obersten Kapitel den Großbuchstaben-römischen Zahlenstil (siehe ).
Probleme beim Erstellen eines schön formatierten Inhaltsverzeichnisses? Siehe Erstellen Sie ein professionell aussehendes Inhaltsverzeichnis.
Kommas und Seitenzahlen. Wenn ein Leader-Dot-Format nicht erforderlich ist und Sie es vermeiden möchten, können Sie dieses allgemein akzeptierte Format verwenden:
Siehe dieses Beispiel für ein Vorwort:
Einfacher Inhaltsverzeichnis-Text mit Kommas und Seitenzahlen.Abbildungsliste
Nicht oft in den Benutzerhandbüchern enthalten...
-->Vorwort
Benutzerhandbuch Hauptkapitel
Anhänge
Index
Andere Elemente des Benutzerhandbuchs
Überschriften
Aufzählungs- und Nummerierte Listen
Symbole, Zahlen und Abkürzungen
Grafiken und Abbildungstitel
Querverweise
Seitenzahl
AI-Aufforderungen für Benutzerhandbücher
Checklisten, die normalerweise ungelesen bleiben, können mit einigen Modifikationen als Quelle für KI-Eingaben verwendet werden. Kopiere das Folgende, füge es in ein KI-System wie Googles Gemini ein und sieh nach, was du möglicherweise übersehen hast.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Benutzerhandbüchern oder deren Komponenten sind zu finden in der Online-Technik-Schreibbuch.
Wenn Sie KI nutzen möchten, um ein Schreibprojekt zu bewerten, stellen Sie sich vor, sagen Sie der KI, wer Sie sind und was Sie möchten. Geben Sie der KI einen Bezugspunkt für die Bewertungen, wie ein Online-Lehrbuch. Dann posten Sie, was Sie möchten, dass die KI in ihrer Bewertung überprüft.
Passen Sie die Einführung an Ihre Identität an.
|
KI-Prompt-Benutzerhandbücher Hallo, KI. Ich bitte dich, die Anweisungen zu bewerten, die von einem Zweitsemester-Studenten an einer US-Hochschule verfasst wurden. Unten folgt eine Zusammenfassung der Kapitel des Lehrbuchs über Anweisungen und Hinweise um als Grundlage für Ihre Bewertung zu dienen. (Identifizierende Informationen anonymisiert):
|
Verwandte Informationen
Wie man benutzerfreundliche Hilfethemen für Anfänger schreibt. clickhelp.com
Wie man Benutzerdokumentation schreibt. techscribe
Benutzerhandbücher. techscribe
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort—David McMurrey.
