Hei! Saya Katya, kepala tim penulisan teknis di Ozon. Sekarang kami memiliki 9 orang dan seluruh platform dokumentasi, tetapi rekan kerja masih tidak selalu mengerti apa yang kami lakukan.
Karena kesalahpahaman, permintaan formulir muncul: "Kami ingin penulis teknis kami sendiri untuk tim, tetapi kami tidak tahu persis apa yang akan dia lakukan". Hasilnya, tim menyesuaikan dengan tren dan membuat dokumentasi untuk dirinya sendiri, tetapi setelah beberapa bulan ternyata dok tidak dibaca, dan penulis teknis dengan lancar berubah menjadi analis.
Maka dari itu, saatnya berbagi pengalaman dan membicarakan beberapa hal konseptual :)
Siapa sih penulis teknologi itu?
Saya menemukan jawaban yang berbeda, dari "orang yang menulis Talmud yang tidak perlu menurut GOST" hingga definisi yang cukup dekat dengan kenyataan saya.
Di Ozon, penulis teknis bekerja secara global dalam tiga bidang:
dokumentasi pengguna (Bantuan, Basis Pengetahuan, FAQ),
dokumentasi API eksternal,
mendeskripsikan sistem internal - dari orientasi hingga interaksi arsitektur yang kompleks.
"" — — Ozon , . , , .
— , , . , , , .
, , , .
, - . API — " - ".
, ?
, - — . "" . , , , .
:
— .
- , — , " " " ".
- — , - — , . : ", , ", , .
— , . , , . .
?
, .
- . ( ) ; , , 24/7 — . - , — .
, — , . , , — , IT.
, - . , , . , , , . , , 10 .
?
. , , — , , - . — , .
:
.
, . , , .
, — .
- .
— - .
. , — - . , .
— . , : , . — , , .
, , , - , . " , " — , , , .
: 1.5 . — , - .
:
, , :
? , ?
? ? , - YouTube?
, ? , , URL ?
, ? ? ?
, . .
?
— , , .
, , :)