Seitenlayout bedeutet für verschiedene Menschen unterschiedliche Dinge, aber hier wird es die Verwendung von Typografie und Formatierung bedeuten, wie man sie in professionell gestalteten Dokumenten sieht.
Unser Fokus liegt hier auf technischer Dokumentation, die ein bescheidenes, funktionales Design impliziert.
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 von technischen Veröffentlichungen. Jede aktuelle Auflage. Microsoft Press.
Kopfzeilen und Fußzeilen
Menschen verwechseln oft Header mit Überschriften. Überschriften, die behandelt werden in Überschriften treten diese Phrasen auf im Körperbereich eines Dokuments. Überschriften sind diejenigen Phrasen und möglicherweise Seitenzahlen, die auftreten im Kopfbereich eines Dokuments. Fußzeilen sind jene Phrasen und möglicherweise Seitenzahlen, die auftreten im Fußbereich eines Dokuments. Ein häufiger Fehler, und ein großer, besteht darin, den Titel eines Dokuments in den Kopfbereich zu setzen, was dazu führt, dass er oben auf jeder nachfolgenden Seite erscheint.
Schauen Sie sich ein Diagramm einer typischen Dokumentseite an:
Ein gängiges Seitenlayout besteht darin, den Dokumenttitel und die Seitenzahl im Fußbereich zu platzieren. In einem alternierenden Format könnte die linke Seite die Seitenzahl und den Dokumenttitel in dieser Reihenfolge anzeigen; die rechte Seite könnte den Dokumenttitel und die Seitenzahl in dieser Reihenfolge anzeigen.
Überschriften
Die folgenden Punkte enthalten einige der allgemeinen Richtlinien zu Überschriften. Für eine detailliertere Diskussion siehe das Kapitel über Überschriften im Online-Lehrbuch.
- Verwenden Sie großzügig Überschriften, vielleicht eine Überschrift für alle zwei bis drei Absätze. Natürlich können Überschriften übertrieben werden: viele Überschriften mit nur ein oder zwei Sätzen pro Überschrift funktionieren nicht.
- Gestalten Sie Überschriften so, dass sie ihre Ebene klar anzeigen. Verwenden Sie Schriftgröße, Schriftstil, Farbe, Fett, Kursivschrift und Ausrichtung so, dass die Ebene der Überschrift offensichtlich ist. („Ebenen“ von Überschriften entsprechen den Ebenen in einer Gliederung: Die erste Ebene würde den römischen Zahlen entsprechen; die zweite Ebene den Großbuchstaben; und so weiter.)
- Gestalten Sie Überschriften, die die eingeführten Abschnitte beschreiben. Überschriften wie "Technischer Hintergrund" sagen niemandem etwas.
- Überschriften erstellen parallel In der Formulierung. Parallelismus gibt den Lesern wichtige Hinweise, ob der Abschnitt in seiner Natur den vorhergehenden ähnlich ist.
- Vermeide "einsame Überschriften"—es ist dasselbe Konzept wie ein "A" ohne ein "B" oder eine "1" ohne eine "2" in Gliederungen.
- Vermeiden Sie "gestapelte Überschriften"— das sind zwei oder mehr aufeinanderfolgende Überschriften ohne dazwischen stehenden Text.
- Vermeiden Sie es, in den Text nach Überschriften auf Pronomen zu verweisen. Wenn Sie eine Überschrift wie „Konfigurieren der Software“ haben, folgen Sie ihr nicht mit einem Satz wie „Dieser nächste Schritt...“.
- Erwägen Sie die Verwendung des "hängenden Kopf"-Formats, um Überschriften hervorzuheben und die Länge der regulären Textzeilen zu reduzieren. Im hängenden Kopfdesign befinden sich einige oder alle Überschriften am linken Rand, während der gesamte Text ein bis zwei Zoll eingerückt ist.
- Erwägen Sie die Verwendung von "Laufenden" Überschriften für Ihre niedrigste Überschrift. Es kann schwierig sein, sich ausschließlich auf Schriftart und -größe zu verlassen, um die Überschriftsebenen anzuzeigen. Eine laufende Überschrift "läuft in" den Beginn eines Absatzes hinein und endet mit einem Punkt. Sie können eine Kombination aus Fett, kursiv oder Farbe für diese Überschriften verwenden.
Listen
Listen sind nützliche Werkzeuge, um wichtige Punkte zu betonen, ein schnelles Durchsuchen des Textes zu ermöglichen und mehr weißen Raum zu schaffen. Die folgenden Punkte präsentieren einige der grundlegenden Richtlinien zu Listen. Für eine ausführlichere Diskussion siehe das Kapitel über Listen.
- Verwenden Sie nummerierte Listen für Elemente, die in einer bestimmten Reihenfolge stehen müssen oder auf die durch eine Zahl verwiesen werden muss. Verwenden Sie Aufzählungslisten für Elemente in keiner bestimmten Reihenfolge.
- Verwenden Sie die in den Absatzformaten von Textverarbeitungssoftware, HTML-Tags und anderen verfügbaren Standard-Listenformate mit Nummerierung und Aufzählungen.
- Formulieren Sie die Aufzählungspunkte. parallel.
- Alle Listen sollten mit einer Einleitung versehen werden; verwenden Sie keine Überschriften als Einleitung zu den Listen.
- Es sei denn, der Stil Ihrer Organisation sieht etwas anderes vor, setzen Sie am Ende von Aufzählungspunkten einen Punkt nur, wenn es sich um vollständige Sätze oder um eingebettete abhängige Klauseln handelt.
- Verwenden Sie entweder Groß- oder Kleinschreibung am Anfang von Listenpunkten, aber tun Sie dies konsistent.
- Für geschachtelte Listen verwenden Sie einen fett gedruckten Gedankenstrich als Aufzählungszeichen für die Auflistungspunkte der zweiten Ebene; verwenden Sie Kleinbuchstaben für die nummerierten Punkte der zweiten Ebene. Stellen Sie sicher, dass geschachtelte Elemente ausgerichtet sind zu der Text oder die vorherige Stufe.
- Vermeiden Sie übermäßigen Gebrauch von Listen oder Listen mit zu vielen Punkten. Sieben bis zehn Punkte gelten im Allgemeinen als das Maximum für Listen.
Hinweise
Hinweise sind speziell formatierte Textabschnitte, die die Leser auf besondere Punkte, Ausnahmen, mögliche Probleme oder Gefahren aufmerksam machen. Im Folgenden werden einige der Standardrichtlinien für Hinweise dargestellt. Für eine detailliertere Diskussion siehe das Kapitel über Hinweise.
- Verwenden Sie eine standardisierte Hierarchie von Hinweisen, in der Hinweise bei zunehmender Schwere prominenter und auffälliger werden.
- Berücksichtigen Sie die Verwendung dieser Hierarchie:
- Gefahrenhinweise für Situationen, die potenziell zu schweren Verletzungen oder Todesfällen führen können
- Warnungen für Situationen mit leichten Verletzungen
- Vorsichtsmaßnahmen für Situationen, die Schäden an Geräten oder Daten oder Bedrohungen für den Erfolg des Verfahrens betreffen.
- Notizen zu Punkten von Ausnahme oder Betonung, die die vorhergehenden Situationen nicht betreffen.
- Egal welches Design Sie für das Notice verwenden, vermeiden Sie langen Text in durchgehend fetter Schrift, durchgehend kursiver Schrift, in Großbuchstaben oder Kombinationen davon.
- Neben der Aufforderung an die Leser, etwas zu tun oder zu lassen, erklären Sie, was passiert, wenn sie die Warnung ignorieren, unter welchen Bedingungen die Aussage genutzt werden sollte und wie man sich erholen kann, wenn die Aussage ignoriert wird.
- Die Texte der Mitteilungen sollten prägnant sein, jedoch nicht auf Kosten einer klaren Schreibweise. Vermeiden Sie einen telegraphischen Schreibstil (Auslassung von Artikeln wie). a, an, das) in Mitteilungen.
- In nummerierten Listen, richten Sie die Hinweise an die text des Listenelements, auf das sie sich beziehen.
- Die gängige Weisheit, Bekanntmachungen zu platzieren vor Der Schritt, in dem das potenzielle Problem besteht, kann Probleme bei der Formatierung verursachen. Wenn möglich, geben Sie Warnungen, Vorsichtsmaßnahmen oder Gefahren zu Beginn des gesamten Verfahrens an.
Abbildungen
Abbildungen sind alle Arten von Illustrationen, Zeichnungen, Sche diagrammen, Fotos und so weiter. Siehe Grafik für eine detaillierte Diskussion. In der Zwischenzeit hier einige wichtige Punkte:
- Im Text vor der Abbildung geben Sie einen Querverweis auf die Abbildung an.
- Während es nicht unbedingt notwendig ist, eine Bildunterschrift (Titel) für jede Abbildung einzufügen, sollten Sie sie, wenn Sie es tun, platzieren. darunter die Figur.
- Zum Beispiel haben in Anleitungen, wenn die Abbildungen eng mit den einzelnen Schritten verbunden sind, Abbildungstitel keine wesentliche Funktion und sind nicht erforderlich.
Tische
Tabellen sind wie vertikale Listen, die zuvor besprochen wurden, jedoch strukturierter und formeller. Suchen Sie in Ihrem Text nach wiederkehrenden Paaren, Triplets oder Quadruplets von Elementen, die als Tabellen formatiert werden können. Zum Beispiel ist eine Reihe von Begriffen und Definitionen eine klassische Verwendung für Tabellen. Im Folgenden sind einige der Standardrichtlinien für Tabellen aufgeführt. Für eine detailliertere Diskussion siehe das Kapitel über Tische.
- Suchen Sie nach sich wiederholenden Gruppen von Elementen in Ihrem Text, die Sie als Tabellen formatieren können.
- Im Text vor der Tabelle einen Querverweis auf die Tabelle einfügen.
- Verwenden Sie einen Tabellentitel, es sei denn, der Inhalt der Tabelle ist völlig offensichtlich und die Tabelle enthält nur wenige Elemente. Platzieren Sie den Tabellentitel oben die Tabelle, oder machen Sie es zur obersten Reihe der Tabelle.
- Verwenden Sie Spalten- und Zeilenüberschriften (oder beides), um den Inhalt der Spalten und Zeilen zu definieren. Erwägen Sie, eine Art Hervorhebung für diese Spalten- und Zeilenüberschriften zu verwenden.
- Richten Sie Textspalten links aus (es sei denn, es handelt sich um einfache alphabetische Zeichenitems). Richten Sie Textspalten mit ihren Überschriften links aus.
- Rechtsbündig oder dezimal ausrichten numerische Daten und zentrieren unter der Überschrift.
- Standardmaßeinheiten einfügen (ft, mm, gal.) in der Spalten- oder Zeilenüberschrift statt mit jedem Element in der Spalte oder Zeile.
- Geben Sie eine kurze Diskussion über den Haupttrend in der Tabelle —, was Sie möchten, dass die Leser beachten.
Hervorhebung
Softwaredokumentation verwendet typischerweise viel Hervorhebung. Hervorhebung bezieht sich hier auf Fettdruck, Italics, alternative Schriftarten, Großbuchstaben, Anführungszeichen und andere typografische Tricks, die dazu verwendet werden, um auf Text aufmerksam zu machen. Die folgenden Punkte präsentieren einige Standardrichtlinien für die Hervorhebung. Für eine detailliertere Diskussion siehe das Kapitel über hervorheben.
- Erstelle einen Plan für die Verwendung von Hervorhebungen und wende ihn konsequent an. Verwende Hervorhebungen aus bestimmten, funktionalen Gründen. Vermeide zu viel Hervorhebung; vermeide komplizierte Hervorhebungsschemata.
- Betrachten Sie die Verwendung dieses recht standardmäßigen Hervorhebungsschemas:
- Für einfache Betonung verwenden Sie Kursivschrift.
- Verwenden Sie **Fettdruck** für Befehle, auf dem Bildschirm angezeigte Schaltflächen und Menüoptionen.
- Verwenden Sie *kursiv* für Variablen, für die Benutzer ihre eigenen Wörter angeben müssen.
- Verwenden Sie eine alternative Schriftart für Texte, die auf dem Bildschirm angezeigt werden oder die Benutzer eingeben müssen.
- Für Bildschirm- und Feldnamen verwenden Sie den auf dem Bildschirm gezeigten Großschreibstil, jedoch keine andere Hervorhebung.
- Verwenden Sie ein Anfangszeichen für Schlüsselnamen, aber keine andere Hervorhebung.
- Für zusätzliche Betonung verwenden Sie das Hinweis-Format.
Ränder, Einzüge & Ausrichtung
Wie im Abschnitt über Überschriften erwähnt, ist es eine nette Geste, den Text um ein bis zwei Zoll einzurücken, während die Überschriften an den linken Rand bleiben. Dieser Stil bewirkt zwei Dinge: Er lässt die Überschriften hervorstechen und verkürzt die Zeilenlänge des regulären Textes.
Schriftarten & Farben
Hier sind einige Vorschläge zu Schriftarten und Farben:
- Verwenden Sie nur eine alternative Schriftart, höchstens zwei. Zum Beispiel könnten Sie Arial für Überschriften, Times New Roman für Fließtext und Courier New für Text verwenden, der auf dem Bildschirm angezeigt wird oder den die Benutzer eingeben müssen.
- Wenn Sie Farbe verwenden, nutzen Sie sie sparsam. Wenn Sie zum Beispiel schwarzen Text auf einem weißen Hintergrund haben, könnten Sie eine andere Farbe für Überschriften auswählen. Sie könnten diese gleiche Farbe auch für Abbildungs- und Tabellentitel sowie für die Tags von Hinweisen verwenden (die tatsächlichen "Hinweis-", "Warnung-", "Vorsicht-" und "Gefahr-" Beschriftungen auf Hinweisen).
- Vermeiden Sie ungewöhnliche Kombinationen von Hintergrund- und Textfarben. Zum Beispiel ist lila oder roter Text auf schwarzem Hintergrund schrecklich zu lesen. Halten Sie sich an schwarzen Text auf weißem oder grauem Hintergrund, es sei denn, es gibt einen starken funktionalen Grund für eine andere Farbkombination.
Ich würde Ihre Gedanken, Reaktionen und Kritiken zu diesem Kapitel schätzen: Ihre Antwort.
