Ei! Sou Katya, chefe da equipe de redação técnica da Ozon. Agora temos 9 pessoas e toda uma plataforma de documentação, mas os colegas ainda nem sempre entendem o que estamos fazendo.
Por mal-entendido, surgem pedidos do formulário: “Queremos nosso próprio redator técnico para a equipe, mas não sabemos exatamente o que ele fará”. Como resultado, a equipe se ajusta às tendências e cria documentação para si mesma, mas depois de alguns meses, descobre-se que o dock não foi lido e o redator técnico se transformou sem problemas em um analista.
Portanto, é hora de compartilhar experiências e falar sobre algumas coisas conceituais :)
Afinal, quem são os escritores de tecnologia?
Eu encontrei respostas diferentes, de "caras que escrevem Talmuds desnecessários de acordo com GOSTs" a definições que estão bem próximas da minha realidade.
Na Ozon, os escritores técnicos trabalham globalmente em três áreas:
documentação do usuário (Ajuda, Base de Conhecimento, FAQ),
documentação de API externa,
descrevendo sistemas internos - de integração a complexas interações arquitetônicas.
"" — — Ozon , . , , .
— , , . , , , .
, , , .
, - . API — " - ".
, ?
, - — . "" . , , , .
:
— .
- , — , " " " ".
- — , - — , . : ", , ", , .
— , . , , . .
?
, .
- . ( ) ; , , 24/7 — . - , — .
, — , . , , — , IT.
, - . , , . , , , . , , 10 .
?
. , , — , , - . — , .
:
.
, . , , .
, — .
- .
— - .
. , — - . , .
— . , : , . — , , .
, , , - , . " , " — , , , .
: 1.5 . — , - .
:
, , :
? , ?
? ? , - YouTube?
, ? , , URL ?
, ? ? ?
, . .
?
— , , .
, , :)