Ich bin verantwortlich für die Entwicklung der internen IT-Dokumentation, habe aber erst begonnen, an der Oberfläche der technischen Dokumentation zu kratzen.
Gibt es einen Standard oder eine bewährte Vorgehensweise für Folgendes:
Beispiel 1: Gehen Sie zu Datei > Einstellungen
Beispiel 2: Gehen Sie zum Anwendungsordner
Sollen Benutzeraktionen (Beispiel 1) und Ziele (Beispiel 2) gleich behandelt werden?
Ein Titel oder Link zu Ihrer Lieblingsressource wäre WIRKLICH hilfreich.
Der Standard, den ich am häufigsten und wahrscheinlich am klarsten fand, ist, alles, was auf dem Bildschirm erscheint, als zu zitieren fixed-width font on grey background
. Die Verwendung von Unicode-Pfeil nach rechts → ist der elegante und elegante Weg, um eine Durchquerung der Benutzeroberfläche abzukürzen.
File
Sie → Preferences
und wählen Sie die Advanced
Registerkarte aus.Allocated memory
30 MB ein und bestätigen Sie mit [OK]
.(Vorzugsweise macht es eine Serifenschrift mit fester Breite wie Courier noch klarer.)
Beschreiben Sie bei ausgefalleneren Symbolen deren Aussehen nur, wenn Sie unbedingt müssen. Versuchen Sie andernfalls, echte Bilder zu verwenden. Ihr dürft sie auch gerne benennen, aber die Bilder sind ganz wichtig.
Sie können optional separates Markup für [buttons]
, [x] checkboxes
( [ ] unchecked too
), (o) radiobuttons
, , verwenden /tabs\
, aber es ist ziemlich selten (außerhalb von Schaltflächen [OK]
oder [x]
Schließen-Schaltflächen sind ziemlich üblich.)
Beschreiben Sie ansonsten, was Sie zu erreichen versuchen und was die erwarteten Ergebnisse sind, insbesondere wo sich das angegebene Element befindet ( verwenden Sie den Dateidialog, um zum Applications
Ordner zu gehen ; wählen File
Sie → Preferences
aus dem Fenstermenü ) .
Verwenden Sie Kursivschrift , um variable Inhalte zu beschreiben – nicht wörtliche Zitate. Verwenden Sie Fettdruck , um Text zu beschreiben, der vom Benutzer eingegeben werden soll. Sie können alle typografischen Konventionen kombinieren (z. B. variable vom Benutzer eingegebene Inhalte, die auf dem Bildschirm erscheinen).
NIC0-MAC:
HW Address
telnet
address port
Eine gute Quelle dafür ist:
Welche Konvention Sie auch verwenden: Dokumentieren Sie sie. Fügen Sie einen Abschnitt „Über dieses Dokument“ hinzu, in dem Sie erklären, was Ihre Konventionen bedeuten.
Übertreiben Sie es auch nicht. Ein Dokument, das 10 verschiedene Stile verwendet, um bestimmte Arten der Benutzerinteraktion anzuzeigen, wird den Leser nur verwirren.
Wenn Sie eine Schriftart mit festem Abstand verwenden, ist so ziemlich alles besser als Courier. Ich bin teilweise für den (Open-Source-) Source Code Pro .
Ginag