Hey! Je suis Katya, responsable de l'équipe de rédaction technique d'Ozon. Nous avons maintenant 9 personnes et toute une plateforme de documentation, mais les collègues ne comprennent toujours pas toujours ce que nous faisons.
Par malentendu, des demandes du formulaire apparaissent: «Nous voulons notre propre rédacteur technique pour l’équipe, mais nous ne savons pas exactement ce qu’il va faire». En conséquence, l'équipe s'adapte aux tendances et crée de la documentation pour elle-même, mais après quelques mois, il s'avère que le dock n'est pas lu et que le rédacteur technique s'est progressivement transformé en analyste.
Par conséquent, il est temps de partager des expériences et de parler de certaines choses conceptuelles :)
Qui sont les rédacteurs techniques de toute façon?
J'ai rencontré différentes réponses, des «gars qui écrivent des Talmuds inutiles selon les GOST» aux définitions qui sont assez proches de ma réalité.
Chez Ozon, les rédacteurs techniques travaillent dans le monde entier dans trois domaines:
documentation utilisateur (Aide, Base de connaissances, FAQ),
documentation API externe,
décrivant les systèmes internes - de l'intégration aux interactions architecturales complexes.
"" — — Ozon , . , , .
— , , . , , , .
, , , .
, - . API — " - ".
, ?
, - — . "" . , , , .
:
— .
- , — , " " " ".
- — , - — , . : ", , ", , .
— , . , , . .
?
, .
- . ( ) ; , , 24/7 — . - , — .
, — , . , , — , IT.
, - . , , . , , , . , , 10 .
?
. , , — , , - . — , .
:
.
, . , , .
, — .
- .
— - .
. , — - . , .
— . , : , . — , , .
, , , - , . " , " — , , , .
: 1.5 . — , - .
:
, , :
? , ?
? ? , - YouTube?
, ? , , URL ?
, ? ? ?
, . .
?
— , , .
, , :)