trabajo de un redactor técnico está dedicado a mis redactores técnicos rusos favoritos : crear documentos para productos de software, básicamente todo tipo de manuales de usuario. Desarrollar un documento no es fácil. Hay muchos enfoques y prácticas. Por ejemplo, los escritores técnicos en empresas científicas e industriales a menudo escriben de acuerdo con GOST u otros estándares nacionales. Su objetivo es describir el producto de forma precisa y correcta. Y los redactores técnicos de empresas internacionales escriben de acuerdo con guías de estilo (el Manual de estilo de Microsoft, por ejemplo). En este caso, el objetivo es transmitir al usuario cómo funciona el producto. Aquí, el enfoque se desplaza del producto al lector.
He sido redactor de tecnología en diferentes lugares, con diferentes reglas y políticas. Mirando hacia atrás, puedo decir que incluso en los institutos de investigación, los textos se pueden reorientar hacia el usuario final, y los documentos se beneficiarán de esto. Pero no escriben sobre eso en GOST. Y las guías de estilo, en primer lugar, están en inglés y, en segundo lugar, no se publicitan en oficinas nacionales como NPP, KB, etc. Por tanto, hay una clara falta de información. Intentaré llenarlo.
¿En qué se diferencian los muelles de los productos Yandex, Google, Microsoft, Apple de la documentación de la vieja escuela creada por ingenieros de diseño?
El ingeniero clásico escribe para que el producto se describa de la manera más completa y correcta posible + de acuerdo con los GOST y la terminología aceptada. Además, muchos términos y definiciones en GOST están desactualizados y no colorean los documentos en absoluto. Pero esto no es un problema para los constructores; nadie piensa siquiera si el texto es fácil de entender para el usuario. Pero los muelles hechos para las personas son diferentes: están escritos en un lenguaje comprensible y tienen en cuenta los intereses del usuario. Cuestión de prioridades.
Estas prioridades y objetivos del autor influyen en gran medida en los documentos que se obtienen. Veamos con ejemplos cómo se ve en la vida real:
| Enfoque de diseño | Orientado al usuario
|
|
|---|---|---|
| Simplicidad de términos
|
Haga clic en el icono de la carpeta con un clic LMB del mouse.
|
.
|
|
|
20- , , . .
|
, , . |
|
|
. «». , . «».
|
. |
| , . . , , .
|
, . , .
|
|
|
|
. – , .
|
: , , .. , .
|
|
|
: , , , , .
|
, . , . , , .
– . – . , . |
Sucede que miras los documentos y ya están desactualizados. Es como leer las instrucciones de un tractor de los años 50. Necesitamos hacerlos de alguna manera más relevantes, pero parece imposible. De hecho, todo es posible. En los siguientes artículos, analizaré paso a paso cómo pasar exactamente de un enorme conjunto de documentación obsoleta a muelles modernos, ligeros y comprensibles. Analizaremos cada uno de los puntos de la tabla en un artículo aparte.
Revelación
No sera facil.