Wenn Sie beschuldigt wurden, ein Dokument geschrieben zu haben, das eine andere Person anweisen soll, etwas zu tun, werden die alten Methoden durch die heutige Vorgehensweise mehr oder weniger aus dem Fenster geworfen.
1. Große bombastische Header
Sie werden feststellen, dass die Überschriften auf PCMech, wie die rechts über diesem Satz, sehr groß sind. Dies liegt daran, dass sie leichter zu sehen, zu lesen und zu wissen sind, wo Sie sich im Dokument befinden.
2. Weniger Wörter
Falscher Weg:
In der folgenden Dokumentation wird die Verwendung und Bedienung des Fanny Whacker 2000 erläutert.
Richtiger Weg:
Anleitung zur Benutzung des Fanny Whacker 2000
Denken Sie beim Verfassen der Dokumentation immer an diesen Satz: KOMMEN SIE SO SCHNELL WIE MÖGLICH AUF DEN PUNKT.
3. Übergehen Sie unbrauchbare Referenzen
Wenn die Referenz nichts mit der Kernanweisung des zu beschreibenden Objekts zu tun hat, z. B .:
Weitere Informationen zum Turnip Twaddler von Fanny Whacker 2000 finden Sie in Dokument FU, Unterabschnitt ID10T.
… Tu das nicht.
4. Verabrede dich. Immer.
Das Datum, an dem die Dokumentation erstellt wurde, sollte im Fußbereich jeder Seite stehen. Wenn es sich um ein elektronisches Dokument handelt, wird das Datum zweimal angezeigt. Einmal am Anfang, einmal am Ende.
Sie können dies als "Zuletzt überarbeitet (Datum hier einfügen)" schreiben.
5. Warnungen sollten immer vor dem Zeitpunkt der Nichtrückgabe angezeigt werden
Wenn sich in Ihrer Dokumentation etwas befindet, das bei unsachgemäßer Ausführung möglicherweise etwas beschädigen / zerstören / auslöschen könnte, sollten Sie diese Informationen direkt nach dieser Anweisung anbringen, sie gut sichtbar (dh auf derselben Seite) und hervorheben.
Beispiel:
Schritt 5. Reinigen des Fanny Whacker 2000
Die Paddel des FW2000 sollten vorsichtig mit einem weichen, nicht scheuernden Tuch gereinigt werden.
WARNUNG: Verwenden Sie nur ammoniakfreies Lösungsmittel, um zu verhindern, dass der FW2000 explodiert und zu Ihrem vorzeitigen Tod führt.
Abschließend muss eine gute Dokumentation nicht über jedes denkbare Detail aussagekräftig sein. Lesen Sie Ihre Dokumentation und fragen Sie sich, ob die Anleitung korrekt ist. Wenn die Antwort ja ist, lautet die nächste Frage: Unterweist sie schnell ? Wenn ja, ist die Dokumentation gut.
