travail d'un rédacteur technique est dédié à mes rédacteurs techniques russes préférés - pour créer des documents pour des produits logiciels, essentiellement toutes sortes de manuels d'utilisation. Développer un document n'est pas facile. Il existe de nombreuses approches et pratiques. Par exemple, les rédacteurs techniques des entreprises scientifiques et industrielles écrivent souvent selon les GOST ou d'autres normes nationales. Leur objectif est de décrire avec précision et précision le produit. Et les rédacteurs techniques des entreprises internationales écrivent selon des guides de style (Microsoft Manual of Style, par exemple). Dans ce cas, l'objectif est plutôt de transmettre à l'utilisateur le fonctionnement du produit. Ici, l'accent est déplacé du produit vers le lecteur.
J'ai été rédacteur technique dans différents endroits, avec des règles et des politiques différentes. Avec le recul, je peux dire que même dans les instituts de recherche, les textes peuvent être réorientés vers l'utilisateur final, et les documents en bénéficieront. Mais ils n'écrivent pas à ce sujet dans les GOST. Et les guides de style, premièrement, sont en anglais, et deuxièmement, ils ne sont pas annoncés dans les bureaux nationaux tels que NPP, KB, etc. Par conséquent, il y a un manque clair d'information. Je vais essayer de le remplir.
En quoi les quais des produits Yandex, Google, Microsoft, Apple diffèrent-ils de la documentation à l'ancienne créée par les ingénieurs de conception?
L'ingénieur classique écrit de manière à ce que le produit soit décrit aussi complètement et correctement que possible + conformément aux GOST et à la terminologie acceptée. De plus, de nombreux termes et définitions dans GOST sont obsolètes et ne colorent pas du tout les documents. Mais ce n'est pas un problème pour les constructeurs - personne ne pense vraiment si le texte est facile à comprendre pour l'utilisateur. Mais les quais conçus pour les gens sont différents: ils sont écrits dans un langage compréhensible et prennent en compte les intérêts de l'utilisateur. Une question de priorités.
Ces priorités et objectifs de l'auteur influencent grandement les documents obtenus. Voyons avec des exemples à quoi cela ressemble dans la vraie vie:
| Approche de conception | Orienté utilisateur
|
|
|---|---|---|
| Simplicité des termes
|
Cliquez sur l'icône du dossier par un clic LMB de la souris.
|
.
|
|
|
20- , , . .
|
, , . |
|
|
. «». , . «».
|
. |
| , . . , , .
|
, . , .
|
|
|
|
. – , .
|
: , , .. , .
|
|
|
: , , , , .
|
, . , . , , .
– . – . , . |
Il arrive que vous regardiez des documents, et ils sont déjà obsolètes. C'est comme lire le manuel d'un tracteur des années 50. Nous devons en quelque sorte les rendre plus pertinents, mais cela semble impossible. En fait, tout est possible. Dans les articles suivants, j'analyserai étape par étape comment, à partir d'un énorme ensemble de documentation obsolète, passer à des quais modernes, compréhensibles et légers. Nous analyserons chacun des points du tableau dans un article séparé.
Divulgacher
Ce ne sera pas facile.