¡Oye! Soy Katya, jefa del equipo de redacción técnica de Ozon. Ahora tenemos 9 personas y toda una plataforma de documentación, pero los compañeros todavía no siempre entienden lo que estamos haciendo.
Por malentendido, aparecen solicitudes del formulario: "Queremos nuestro propio redactor técnico para el equipo, pero no sabemos qué hará exactamente". Como resultado, el equipo se ajusta a las tendencias y crea documentación para sí mismo, pero después de un par de meses resulta que el dock no se lee y el escritor técnico se ha convertido sin problemas en analista.
Por tanto, es hora de compartir experiencias y hablar de algunas cosas conceptuales :)
¿Quiénes son los escritores de tecnología de todos modos?
Encontré diferentes respuestas, desde "tipos que escriben Talmud innecesarios según los GOST" hasta definiciones que se acercan bastante a mi realidad.
En Ozon, los escritores técnicos trabajan a nivel mundial en tres áreas:
documentación del usuario (ayuda, base de conocimientos, preguntas frecuentes),
documentación de API externa,
describir los sistemas internos, desde la incorporación hasta las interacciones arquitectónicas complejas.
"" — — Ozon , . , , .
— , , . , , , .
, , , .
, - . API — " - ".
, ?
, - — . "" . , , , .
:
— .
- , — , " " " ".
- — , - — , . : ", , ", , .
— , . , , . .
?
, .
- . ( ) ; , , 24/7 — . - , — .
, — , . , , — , IT.
, - . , , . , , , . , , 10 .
?
. , , — , , - . — , .
:
.
, . , , .
, — .
- .
— - .
. , — - . , .
— . , : , . — , , .
, , , - , . " , " — , , , .
: 1.5 . — , - .
:
, , :
? , ?
? ? , - YouTube?
, ? , , URL ?
, ? ? ?
, . .
?
— , , .
, , :)