Bitte hier klicken, um zu helfen David McMurrey für Webhosting bezahlen:
Spenden Sie jeden kleinen Betrag, den Sie können.
Online Technisches Schreiben bleibt kostenlos.
Diese Seite wird repariert.
A Benutzerhandbuch ist ein Tech-Dokument, das erklärt, wie ein Benutzer häufige Aufgaben eines Produkts ausführt. Häufig Aufgaben sind die Aktionen, die der Benutzer ausführen können muss. 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 eines dieser Bedürfnisse oder beide erfüllen. Denken Sie an eine Mikrowelle: Sie kann einen Basisbenutzer haben, und das war's. Im Gegensatz dazu kann ein Grafikdesignprodukt sowohl Basisbenutzer als auch fortgeschrittene Benutzer haben.
NotebookLLM-generiertes Infografik dieses Kapitels
In diesem Kapitel, Buchgestaltung Bedeutet den Inhalt, 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 Ausgabennotiz, das Vorwort, das Register oder den Vorder- oder Rückumschlag. In der seitengestaltung 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 Ü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 alle diese Komponenten so gestaltet und in der Reihenfolge angeordnet, wie Sie gleich lesen werden. Stattdessen gibt diese Übersicht einen Überblick über die Möglichkeiten—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 das "d" in "Filepad" nicht entschlüsseln!) Seien Sie sich bewusst, dass es einige der unten aufgeführten Anforderungen an Schriftart und -rand nicht verwendet.
Bevor du mit dem Lesen des Folgenden beginnst, hol dir eine Anzahl von Hardware- und Softwarebüchern, damit du deren Inhalt, Stil, Format und Reihenfolge mit dem, was hier besprochen wird, vergleichen kannst.
Für noch mehr Details als die, die Sie hier sehen, konsultieren Sie bitte diese beiden Standardressourcen der Branche:
- Sun Technische Publikationen. Lies mich zuerst! Jede aktuelle Ausgabe. Prentice Hall.
- Microsoft Corporation. Microsoft-Handbuch für den Stil in technischen Publikationen. Jede aktuelle Ausgabe. Microsoft Press.
Sie können Beispiele für diese Buchkomponenten in Techdoc Design.
Vorder- und Rückseite der Cover
Produktdokumente für zahlende Kunden haben normalerweise ansprechend gestaltete Titelblätter, selbst wenn das Innere des Buches in Bezug auf Qualität eher zweitklassig ist. Auf dem Titelblatt sehen Sie typischerweise einige oder alle der folgenden Elemente:
- Firmennamen
- Produktname
- Produktplattform oder Betriebssystem
- Produktversion und Veröffentlichungsnummern
- Buchtitel
- Unternehmens- oder Produktlogos
- Markensymbole
- Kunstwerk
- Buchbestellnummer
- Unternehmens- oder Produkt-Slogan
Es kann herausfordernd sein, ein gutes Format für den Firmennamen, den Produktnamen und den Buchtitel zu finden. Manchmal kann das eine ganze Textpassage ausmachen! Die Unternehmen sind sich ziemlich uneinig, ob Versions- und Veröffentlichungsnummern auf den Vorderseiten angegeben werden sollten—einige tun es; andere nicht. Fast immer wird jedoch die Plattform angegeben—ob das Produkt für den Macintosh, den PC, UNIX usw. gedacht ist.
Beispiel für eine Titelseite.
Die Rückseite von gedruckten Benutzerhandbüchern und Anleitungen ist normalerweise sehr einfach. In der Regel enthält sie die Bestellnummer des Buches, den Namen des Unternehmens mit entsprechenden Markensymbolen, ein Copyright-Symbol und eine Formulierung zum Eigentum des Buches sowie eine Angabe, in welchem Land das Buch gedruckt wurde. Sie finden auch Strichcodes auf der Rückseite. Überprüfen Sie, ob Ihre Software einen Strichcode generieren kann—, indem Sie einfach das Strichcode-Tool aufrufen und die Bestellnummer des Buches eingeben, und das Tool generiert den Strichcode.
Titelseite
Die Titelseite ist typischerweise eine Duplikation des vorderen Covers, jedoch mit bestimmten weggelassenen Elementen. In der Regel weggelassen sind die Grafiken, Firmen- oder Produktlogos und Slogans. Einige technische Publikationen lassen die Titelseite ganz weg, da die scheinbar unnötige Duplikation keinen Sinn ergibt. (Und bei einer Druckauflage von 20.000 Exemplaren zählt eine einzige Seite viel!)
Beispiel für eine Titelseite.
Ausgabenhinweis
Der Herausgeberhinweis ist typischerweise die erste Stelle mit regelmäßigem Text in einer technischen Publikation, obwohl er normalerweise in kleinerer Schriftgröße erscheint. Er befindet sich auf der Rückseite der Titelseite. Wenn der technische Verlag den lean-and-green-Ansatz verfolgt und die Titelseite eliminiert, erscheint der Herausgeberhinweis auf der Rückseite des Umschlags.
Niemand liest gerne das Kleingedruckte, aber werfen Sie einen Blick auf die Aussagen, die normalerweise in einer Ausgabenbenachrichtigung enthalten sind:
Beispiel einer Ausschreibungshinweise
Marken
Ob Sie Marken eintragen und wie Sie zuhören, ist das Gebiet von Unternehmensjuristen. In jedem Fall listen Sie nur die markengeschützten Produktnamen auf, die in diesem speziellen Benutzerhandbuch vorkommen.
Am häufigsten werden Marken wie folgt angezeigt:
- in der Ausgabenankündigung (wie die obige Abbildung zeigt)
- in einem separaten Abschnitt irgendwo im Benutzerhandbuch
Erwähne diese Notiz.
Wenn Unternehmensanwälte möchten, dass jede Nennung eines markenrechtlich geschützten Produktnamens mit einem Sternchen oder einer Fußnote versehen wird, versuchen Sie, sie von diesem Seitenlayout-Desaster abzubringen. Das Streuen von Sternchen oder Fußnotennummern im Text lenkt die Leser ab.
Garantiebedingungen
Garantiebedingungen begleiten physische Hardwareprodukte—nicht Software. Unternehmensanwälte übernehmen die Verantwortung für die Sprache und das Format der Garantie. Wenn Sie ein Beispielbenutzerhandbuch oder Buch für Ihr Portfolio erstellen, können Sie dieses anonyme "Garantiebeispiel" verwenden.Popup zu zeigen, dass Ihnen bewusst ist, dass Garantien enthalten sein müssen.
Softwaregarantien?Sicherheitsmitteilungen
Hardwareprodukte haben typischerweise einen Abschnitt mit Sicherheitshinweisen am Anfang ihrer Bücher. Diese können beispielsweise als Unterabschnitt im Vorwort oder als separater Abschnitt für sich stehen. Diese Abschnitte bringen typischerweise alle Gefahren-, Warn- und Vorsichtshinweise zusammen, die im gesamten Buch vorkommen, und ordnen sie in einer logischen Weise an. Aber selbst mit diesem vorderen Hinweis platzieren Hardwarebücher die einzelnen Hinweise an den Stellen, an denen sie zutreffen. (Für weitere Informationen siehe) besondere Hinweise.)
Kommunikationsaussagen
Hardwarebücher benötigen ebenfalls Kommunikationshinweise, wie sie von den Regierungen der Länder vorgeschrieben werden, in die diese Produkte versandt werden. In den USA verlangt die FCC bestimmte Kommunikationshinweise, abhängig von der "Klasse" des Hardwareprodukts. Als Autor müssen Sie darauf achten, den richtigen Kommunikationshinweis für das Produkt zu verwenden, das Sie dokumentieren—und die Erklärung in keiner Weise zu bearbeiten (heilige juristische Worte!).
Inhaltsverzeichnis
Das Inhaltsverzeichnis (TOC) enthält normalerweise mindestens eine zweite Detailstufe (die Überschrift 1 im eigentlichen Text), damit die Leser genauer finden können, wonach sie suchen. Autoren, Redakteure und Buchgestalter argumentieren typischerweise ü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 haben, wenn nicht sogar ganz am Anfang. In rechtlicher Hinsicht jedoch sorgen sich die Menschen, dass all diese Mitteilungen, Garantien, Urheberrechte, Marken und Sicherheitshinweise zuerst kommen sollten. Dort, wo die Benutzerfreundlichkeit überwiegt, nutzen Bücher alle Taktiken, die sie können, um dieses rechtliche Material aus dem vorderen Teil zu entfernen: Garantien werden auf separaten Karten ausgelegt und zusammen mit dem Buch oder Produkt in Folie verpackt; Garantien, Mitteilungen, Marken und dergleichen können in Anhänge abgelegt werden.
Probleme beim Erstellen eines gut formatierten Inhaltsverzeichnisses? 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 Titel. Das bedeutet jedoch nicht, dass ein Abbildungsverzeichnis in technischen Handbüchern keinen Platz hat. Es hängt alles vom Leser und den Bedürfnissen des Lesers—und dem 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 tut dies, indem:
- die Inhalte und den Zweck des Buches charakterisieren
- Identifizierung oder auch nur kurze Beschreibung des Produkts, das das Buch unterstützt.
- Erklärung des Leser-Typs, für den das Buch gedacht ist.
- Skizzierung der Hauptinhalte des Buches
- Sonderkonventionen oder Terminologie, die im Buch verwendet werden.
- Bereitstellung von Unterstützung und Marketingzahlen sowie anderen ähnlichen Dingen
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 Verlage, 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 ist nicht alles Frontmatter! Wenig anderes zu sagen hier außer, dass die meisten technischen Bücher Kapitel oder Abschnitte haben und in einigen Fällen Teile. Siehe das Kapitel über Seitenlayout für Format-, Stil- und Designfragen bei Elementen wie Kopfzeilen, Fußzeilen, Überschriften, Listen, Hinweisen, Tabellen, Grafiken, Querverweisen und Hervorhebungen.
Anhänge
Wie Sie wissen, sind Anhänge für Materialien gedacht, die einfach nicht in den Hauptteil eines Buches passen, aber auch nicht weggelassen werden können. 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 wie ein Kapitel—, außer dass er "Anhang A" oder ähnlich benannt ist und die Kopf- und Fußzeilen dieser anderen Nummerierungs- und Benennungs-konvention entsprechen (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 zweispaltiges Layout verwenden. Typischerweise bildet jeder Begriff und dessen Definition einen separaten Absatz, wobei der Begriff in Kleinbuchstaben (es sei denn, es handelt sich um einen Eigennamen) und fettgedruckt ist, gefolgt von einem Punkt, dann die Definition in normalem Roman. Beachten Sie auch, dass Definitionen in der Regel keine vollständigen Sätze sind. Gute Glossar-Definitionen sollten die Technik der formellen Satzdefinition verwenden, wie im Definitionskapitel diesem Online-Text. Mehrere Definitionen werden in der Regel durch arabische Zahlen in Klammern gekennzeichnet. Glossarabschnitte enthalten ebenfalls Sieh Bezüge auf bevorzugte Begriffe und Siehe auch Verweise auf verwandte Begriffe.
Index
Indizes sind auch typischerweise zweispaltig und enthalten ebenfalls sehen Bezüge zu bevorzugten Begriffen und Siehe auch Verweise auf verwandte Begriffe. Siehe das Kapitel über Indexierung für Prozesse und Richtlinien zur Erstellung guter Indizes.
Leserreaktionsformular
Vor dem Aufkommen 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 Aufkommen des Internets sind diese Formulare online gegangen, und Bücher verweisen lediglich 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 spartanischen Weise gestaltet. High-Tech-Unternehmen entwickeln manchmal alle neun Monate neue Versionen und Veröffentlichungen ihres Produkts. In diesem Kontext ist ein anspruchsvolles Design einfach nicht praktisch. Hier sind einige der typischen Layout- und Designelemente, die Sie sehen werden:
- Die Seitengröße wird oft durch Verpackungsüberlegungen sowie durch die standardmäßigen Seitengrößen, die bei Druckereien verfügbar sind, bestimmt. Wenn die Seitengröße keine Einschränkung darstellt, verwenden einige Unternehmen die 8,5 × 11-Zoll-Seitengröße—, was die Produktion für Autoren viel einfacher macht.
- Seiten sind typischerweise mit abwechselnden 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 kapitelweise sind.
- Es sei denn, die Seiten sind recht klein, ist das hängende Kopf-Design von Überschriften in Bezug auf Seiten in technischen Handbüchern ziemlich 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. Standardzeilenabstand und Wortabstand werden verwendet. Siehe das Kapitel über hervorheben für andere typografische Probleme.
- Die Ränder sind ziemlich standardisiert, ein bis zwei Zoll rundherum. Typischerweise wird ein zusätzlicher halber Zoll für die Innenseitenränder verwendet, um das Binden zu ermöglichen.
- Typischerweise ist Farbe nicht in diesen Handbüchern und Leitfäden verwendet, meist aus Kosten- und Effizienzgründen.
Die Übermittlungsnachricht ist entweder ein Begleitschreiben (oder Memo) oder eine E-Mail. Der physische Brief (oder das Memo) ist entweder mit einer Büroklammer außen am Benutzerhandbuch befestigt oder im Benutzerhandbuch eingebunden. Die E-Mail enthält einen Link zum Benutzerhandbuch oder das Benutzerhandbuch als Anhang. Es ist eine Kommunikation von Ihnen—dem Verfasser des Benutzerhandbuchs—an den Empfänger, die Person, die das Benutzerhandbuch angefordert hat und die Ihnen möglicherweise auch für Ihre fachkundige Beratung bezahlt. Im Wesentlichen sagt es: "Okay, hier ist das Benutzerhandbuch, das wir vereinbart haben, dass ich es bis zu einem bestimmten Datum abschließe. Kurz gesagt, es enthält dies und das, aber nicht das oder jenes. Bitte prüfen Sie es und lassen Sie mich wissen, ob es Ihren Anforderungen entspricht."
Inhaltsverzeichnis
Inhaltsverzeichnis
Egal welches Format des Inhaltsverzeichnisses (TOC) Sie verwenden, dies sind die gängigen Standards:
- Startseitenzahl nur. Obwohl einige automatische Inhaltsverzeichnis-Generatoren den Seitenbereich anzeigen, ist die Norm nur die Seitenzahl der ersten Seite.
- Ebenen der Überschriften, die einbezogen werden sollen. Wie im obigen Inhaltsverzeichnis gezeigt, präsentiere die obersten beiden Ebenen der Überschriften, es sei denn, das Benutzerhandbuch hat viele Unterüberschriften. Das Inhaltsverzeichnis sollte eine schnelle und übersichtliche Möglichkeit bieten, Informationen zu finden.
- Abstände und Großschreibung. Beachten Sie, wie die Textelemente im Inhaltsverzeichnis oben eingerückt sind. Überschriften der ersten Ebene sind in Großbuchstaben; Überschriften der zweiten Ebene verwenden Großbuchstaben am Anfang jedes Hauptworts; Überschriften der dritten Ebene verwenden die Satzschrift.
- Vertikaler Abstand. Beachten Sie, dass die Abschnittsüberschriften der ersten Ebene zusätzlichen Platz darüber und darunter haben, was die Lesbarkeit erhöht.
Je nach den Anforderungen Ihrer Organisation haben Sie zwei Formatoptionen für Inhaltsverzeichnisse (TOC):
Dieses Inhaltsverzeichnis verwendet das dezimale Nummerierungssystem für die Kapitel- und Abschnittsnummern, was in Benutzerhandbüchern üblich ist. Andere in diesem Buch verwenden den großen römischen Zahlenstil nur für die Kapitel der obersten Ebene (siehe ).
Probleme bei der Erstellung eines schön formatierten Inhaltsverzeichnisses? Siehe Erstellen Sie ein professionell aussehendes Inhaltsverzeichnis.
Kommas und Seitenzahlen. Wenn ein Leader-Punktformat nicht erforderlich ist und Sie es vermeiden möchten, können Sie dieses allgemein akzeptierte Format verwenden:
Siehe dieses Beispiel eines Vorworts:
Einfacher Inhaltsverzeichnistext mit Kommas und Seitenzahl.Abbildungsliste
Nicht oft in den Benutzerhandbüchern enthalten...
-->Vorwort
Benutzerhandbuch Hauptkapitel
Anhang
Index
Andere Elemente des Benutzerhandbuchs
Überschriften
Aufzählungen und Nummerierte Listen
Symbole, Zahlen und Abkürzungen
Grafiken und Abbildungstitel
Querverweise
Seitennummerierung
KI-Aufforderungen für Benutzerhandbücher
Checklisten, die typischerweise unbeachtet bleiben, können mit einigen Anpassungen als Quelle für KI-Eingabeaufforderungen verwendet werden. Kopieren Sie das Folgende, fügen Sie es in ein KI-System wie Googles Gemini ein und sehen Sie, was Sie vielleicht übersehen haben.
Hinweis: Alle Verweise auf den Inhalt, das Format, den Stil von Benutzerhandbüchern oder deren Komponenten sind im Online-Technikschreibbuch.
Wenn Sie KI verwenden 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 Referenzpunkt für die Bewertungen, wie ein Online-Lehrbuch. Posten Sie dann, was Sie von der KI in ihrer Bewertung überprüfen lassen möchten.
Ändere die Einleitung, um deiner Identität gerecht zu werden.
|
AI Eingabeaufforderungen Benutzeranleitungen Hallo, KI. Ich bitte dich, Anweisungen zu bewerten, die von einem College-Studenten im zweiten Studienjahr in den USA geschrieben wurden. Unten findest du eine Zusammenfassung der Kapitel des Lehrbuchs über Anweisungen und Hinweise als Grundlage für Ihre Bewertung verwenden. (Identifizierende Informationen maskiert):
|
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 Kritik zu diesem Kapitel schätzen: Ihre Antwort—David McMurrey.
