Arbeit eines technischen Redakteurs ist meinen bevorzugten russischen technischen Redakteuren gewidmet - um Dokumente für Softwareprodukte zu erstellen, im Grunde alle Arten von Benutzerhandbüchern. Das Entwickeln eines Dokuments ist nicht einfach. Es gibt viele Ansätze und Praktiken. Beispielsweise schreiben technische Redakteure in Forschungs- und Produktionsunternehmen häufig nach GOST oder anderen inländischen Standards. Ihr Ziel ist es, das Produkt genau und korrekt zu beschreiben. Und technische Redakteure in internationalen Unternehmen schreiben nach Styleguides (z. B. Microsoft Manual of Style). In diesem Fall geht es vielmehr darum, dem Benutzer die Funktionsweise des Produkts zu vermitteln. Hier wird der Fokus vom Produkt auf den Leser verlagert.
Ich war ein Tech-Autor an verschiedenen Orten mit unterschiedlichen Regeln und Richtlinien. Rückblickend kann ich sagen, dass auch in Forschungsinstituten Texte auf den Endnutzer ausgerichtet werden können und Dokumente davon profitieren werden. Aber in GOSTs schreiben sie nicht darüber. Und Styleguides sind erstens in englischer Sprache und zweitens werden sie nicht in inländischen Büros wie NPP, KB usw. beworben. Daher gibt es einen klaren Mangel an Informationen. Ich werde versuchen, es zu füllen.
Wie unterscheiden sich Docks für Yandex-, Google-, Microsoft- und Apple-Produkte von der Dokumentation der alten Schule, die von Konstrukteuren erstellt wurde?
Der klassische Ingenieur schreibt, dass das Produkt so vollständig und korrekt wie möglich + gemäß den GOSTs und der akzeptierten Terminologie beschrieben wird. Darüber hinaus sind viele Begriffe und Definitionen in GOSTs veraltet und färben Dokumente überhaupt nicht. Für Konstruktoren ist dies jedoch kein Problem - niemand denkt wirklich, ob der Text für den Benutzer leicht verständlich ist. Docks für Menschen sind jedoch anders: Sie sind in verständlicher Sprache verfasst und berücksichtigen die Interessen des Benutzers. Eine Frage der Prioritäten.
Diese Prioritäten und Ziele des Autors haben großen Einfluss darauf, welche Dokumente erhalten werden. Lassen Sie uns anhand von Beispielen sehen, wie es im wirklichen Leben aussieht:
| Designansatz | Benutzerorientiert
|
|
|---|---|---|
| Einfachheit der Begriffe
|
Klicken Sie mit der Maus auf das Ordnersymbol.
|
.
|
|
|
20- , , . .
|
, , . |
|
|
. «». , . «».
|
. |
| , . . , , .
|
, . , .
|
|
|
|
. – , .
|
: , , .. , .
|
|
|
: , , , , .
|
, . , . , , .
– . – . , . |
Es kommt vor, dass Sie sich Dokumente ansehen, die bereits veraltet sind. Es ist, als würde man die Anweisungen für einen Traktor aus den 1950er Jahren lesen. Wir müssen sie irgendwie relevanter machen, aber es scheint unmöglich. In der Tat ist alles möglich. In den folgenden Artikeln werde ich Schritt für Schritt analysieren, wie genau von einem riesigen veralteten Dokumentationssatz zu leichten, verständlichen und modernen Docks übergegangen werden kann. Wir werden jeden Punkt in der Tabelle in einem separaten Artikel analysieren.
Spoiler
Es wird nicht einfach sein.