新しいチームの役割:テクニカルライター

ねえ!オゾンのテクニカルライティングチームの責任者であるカティアです。現在、9人のスタッフとドキュメントのプラットフォーム全体がありますが、同僚はまだ私たちが何をしているのかを常に理解しているわけではありません。





誤解から、フォームのリクエストが表示されます。「チームには独自のテクニカルライターが必要ですが、彼が正確に何をするかはわかりません」。その結果、チームはトレンドに適応し、独自のドキュメントを作成しますが、数か月後、ドックが読み取られないことが判明し、テクニカルライターはスムーズにアナリストになりました。  





したがって、経験を共有し、いくつかの概念的なことについて話す時が来ました:)





とにかくテクニカルライターは誰ですか?

「GOSTに従って不要なタルムードを書く人」から、私の現実に非常に近い定義まで、さまざまな答えに出会いました。 





Ozonでは、テクニカルライターは次の3つの分野でグローバルに活動しています。 





  • ユーザードキュメント(ヘルプ、ナレッジベース、FAQ)、 





  • 外部APIドキュメント、 





  • オンボーディングから複雑なアーキテクチャの相互作用まで、内部システムの説明。 





  ""   —   —  Ozon  , .  , , . 





—  , , .  ,  , ,   . 





, ,    , . 





,   - .  API — " - ". 





, ?

, - — . "" .     , , , . 





  : 





  1. —   .  





  2. - ,   — ,  " "  " ". 





  3. - — , - —    , . : ", ,    ", , . 





 — , . ,  , .   .  





?

      , . 





- . ( )  ;   , ,   24/7 —  . - ,   — . 





, — , . , , — , IT. 





,  - . , , .      ,  ,  ,   . , , 10  . 





?

.  , , — , , - .   — ,       . 





    : 





  1. .  





  2. , . , , . 





  3. ,    — . 





  4. -  . 





  5.   — - . 





. , — - .  ,  . 





— . , : ,   . — , ,    . 





, ,   , - ,  . " , " — , , ,    .  





: 1.5   .      — , -  . 





 :  

,  ,  : 





  • ? , ? 





  • ?  ? , -     YouTube? 





  • , ?  , ,  URL   ? 





  • , ? ? ? 





,    .     . 






?

— ,  ,    . 





, , ​:)





 








All Articles