はじめに
最近テクニカルライターに興味ができ、色んなコミュニティやMeetupなどを接しています。特に、株式会社LINEさんからのMeetup動画で良質の情報が提供されていると思います。今回はその動画の中で LINE Technical Writing Meetup vol.24 の一部をまとめてみました。
1. テクニカルライターとは
定義
テクニカルライターとは言葉そのまま「技術文書作成者」と言われています。Wikipediaでは、テクニカルライターの業務を「技術情報を他人に共有・紹介することができること」と説明しています。
Technical writing is performed by a technical writer (or technical author) and is the process of writing and sharing technical information in a professional setting.
A technical writer's primary task is to communicate technical information to another person or party in the clearest and most effective manner possible.
テクニカルライターは、業務の内容によって様々な呼び方があります。
- Technical Communicator (コミュニケーションサポート)
- UX Writer (ユーザー向けのサービス文書)
- API Writer (開発エンジニア向けの技術文書)
- Information Architect (文書の構造化に特化)
- Document Engineer (効果的な文書配布の為のエンジニアリングに特化)
一緒に働くチーム
テクニカルライターが社内で一緒に仕事する職務にはプロジェクトマネージャー、QAエンジニア、デザイナーなどがありその中で開発エンジニアが一番です。
2. テクニカルライターの仕事
テクニカルライターの仕事は大きく2つ挙げられます。一つは今まで開発エンジニアとして経歴を積んできた場合と、もう一つは言語を専攻してきた場合となります。
やることが全く分けられているわけではないのですが、前者は開発用語やプロジェクト一連の流れに慣れているはずなので、技術文書や文書エンジニアリング業務を取り組んだ方がいいかもしれません。
一方、後者は言語感覚を活かして多国語文書作成やリアルタイム翻訳など、グローバル的な業務を取り組んでいくことができます。このように自分の長所を発揮できる業務があると思います。代表的な業務内容は下記の通りです。
- Technical documentation
- Site structuring
- Documentation in multi-languages
- Document engineering
- Writing training
3. テクニカルライターの業務フロー
テクニカルライターがはどんな流れで作業を行っていくのかについては、会社とプロジェクトによって違いがあると思いますが、大体の流れは下記となります。
① 文書作成依頼
: 開発エンジニアまたはプランナーから文書作成の依頼を受ける。
② サポート可能性判断
: テクニカルライターは依頼された内容が文書として作成できるかどうかを判断する。
③ キックオフミーティング
: 文書として作成できると判断した場合、ステークホルダー（関係者たち）が集まってキックオフミーティングを進め、この際開発エンジニアはプロジェクトのストラクチャーを説明する。
④ 文書作成
: 草案は開発エンジニアが作成し、検討が必要であれば開発エンジニアとやり取りをしながら作業を行っていく。
⑤ 翻訳依頼
: 文書作成が完了したら翻訳に進められ、出来上がったら開発エンジニアは技術面に間違いがないのかレビューする。
⑥ 文書リリース
: 最終作成が完了したら文書を公開します。
さいごに
meetupでは、テクニカルライターになるにはどんな履歴が必要なのかという内容より、テクニカルライターについての情報が得られ、同じ興味を持っている人々とのコミュニケーションができるコミュニティを紹介してくれました。
-
Society for Technical Communication
: コンファレンス開催、テクニカルライティング講義 等 -
WRITE THE DOCS
: コンファレンス開催、Slackチャンネル運用、英文ニュースレター提供 -
API the Docs
: コンファレンス開催、API文書作成講義 -
Technical Writing Courses
: Googleのテクニカルライター講座 -
TechDocs Solutions & Consultancy
: 英文テクニカルライティングの講義