分かりやすいドキュメントを書く「テクニカルライター」という仕事 / About the job "Technical writer" who writes easy-to-understand documents

もともとインフラエンジニアをしていた私が、LINEに入るまで知らなかった「テクニカルライターという職種があること」と「LINEにはテクニカルライティング専門のチームがあること」の2つについてお話しします。技術も好きだし、ドキュメントを書いたり、人に教えたりするのも好きだ、という方に「こういうキャリアもあるんだ」と発見してもらえるセッションです。

■ 発表者
堀越 良子 / LINE株式会社 テクニカルライター。元インフラエンジニア。ねこが好き。
https://twitter.com/mochikoAsTech

■ セッション動画
https://youtu.be/nmFVXJGiCxM?t=2817

※こちらは以下イベント内で発表した内容です
https://line.connpass.com/event/205655/

Transcript

1. LINE Technical Writing Meetup vol.1 分かりやすいドキュメントを書く 「テクニカルライター」という仕事 LINE Corporation Developer Content Team Yoshiko Horikoshi 11th March 2021 19:00-21:00
2. 1: これだけ気を付けて書いてもらえると みんな幸せになるポイント2つだけ 2: 分かりやすいドキュメントを書く 「テクニカルライター」という仕事 3: Questions and Answers 11th March 2021 19:00-21:00 LINE Technical Writing Meetup vol.1
3. ⾃⼰紹介
4. はじめまして 「ほりこし」です
5. LINE Corporation Developer Content Team
6. 2020年1⽉から LINEでテクニカルライター
7. Yoshiko Horikoshi @mochikoAsTech プログラマ（3年） 広報（4年） インフラエンジニア（7年） 2020年1⽉からLINEでテクニカルライター
8. きみきみ、⼀緒に テクニカルライター してみないかね︖
9. 1. テクニカルライターという職種があること 2. LINEにはテクニカルライティング専⾨の チームがあること ⽮崎さんから話を聞くまで知らなかったこと
10. 「知らなかった︕」 という⼈の⽅が 多いのではないか︖
11. 今⽇の内容 Agenda
12. もともとインフラエンジニアだった私が LINEに⼊るまで知らなかった 1. テクニカルライターという職種があること 2. LINEにはテクニカルライティング専⾨の チームがあること の2つについてお話しします
13. 技術も好きだし、ドキュメントを書いたり ⼈に教えたりするのも好きだ、という⽅に 「こういう仕事もあるんだ︕」 と発⾒してもらえたらいいな
14. もっと⼿前の そもそもから話すと
16. LINE Technical Writing Meetupは、テクニカルライティングをテーマにした技術者向けの ミートアップです。 エンジニアをしていると、⽇々仕事でドキュメントを書いたり読んだり、あるいは個⼈的に調 べたことをブログにまとめたり、公私を問わず技術的な⽂章に触れる機会が多いと思います。 もっと分かりやすいドキュメントが書けるようになりたいな、複雑な技術のこともうまく伝え られるようになりたいな、そんな⾵に「書くこと」や「つたえること」について課題感を持っ ている⽅も少なくないのではないでしょうか。 このミートアップでは、LINEでテクニカルライティングを専⾨としているメンバーが集まって、 もっと「分かりやすくつたえる」ための知⾒を共有していきます。
18. テクニカルライティングを 専⾨としているメンバー っていったいだれ︖何してる⼈なの︖
19. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
20. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
21. LINEのテクニカルライターは、主に 社外の開発者向けにドキュメントを提供する という仕事をしています
22. ⾃社で運営するサイトに 「LINEログイン」ボタンを つけて、エンドユーザが LINEのアカウントでも ログインできるように してあげたい︕
23. 「LINEログイン」ボタンを つけたい︕ でもこれ、どうやって 実装すればいいのかな︖
24. LINEのテクニカルライターは、そういう⼈のために ドキュメントやAPIリファレンスを書いて公開しています https://developers.line.biz/ https://clova-developers.line.biz/
25. ドキュメントは⽇本語と英語で同時公開
26. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
27. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
28. マークダウンでドキュメントを書いて ローカルの開発環境でデプロイして確認します
29. GitHubのリポジトリへプッシュして プルリクエストを作ります
30. 別のライターやプロダクトの担当者が Sandboxで確認してレビューします
31. レビューを終えてmasterへマージすると Jenkinsがデプロイしてくれてリリース完了
32. あとはリリースされたら みんなで「わーい」と喜びます︕
33. 先に⽇本語で書いてから英訳することもあるし 英語で書いてから⽇本語訳することもある
34. 仕様インプットのために最初に30分くらい 開発担当とのミーティングをすることもあるし 仕様が書かれたWikiをもらって書く場合もある
35. 2020年下期は 半年で116回リリースしていたので おおよそ1⽇に1回はリリースしている
36. 新しいサービスの ドキュメントを書きつつ 今あるドキュメントも 直したり拡充したり
37. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
38. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
39. Developer Content Team 2021年3⽉時点
40. 余談︓ 社内に通訳翻訳チームがいて 必要なミーティングには 通訳が⼊ってくれます
41. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
42. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
43. ドキュメントを書く以外にこんなこともしています • 他部署が作った社内資料のレビュー • 社内Wikiの構成⾒直し • 社内研修 • 分かりやすい⽂章の書き⽅講座（900⼈） • 教え上⼿になろう講座（900⼈） • 分かりやすい伝え⽅講座（600⼈）
44. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
45. ⾃分で⼿を動かして実装せず ドキュメントを書くだけになってしまうと ⾃分が「技術」から離れてしまうのでは︖ という⼼配があった
46. 実際、テクニカルライターとして 働いてみてどうだったか︖
47. 杞憂だった︕
48. LINEログインのドキュメント書いて︕ →OAuthを理解する必要があった Messaging APIのFlex Messageの ドキュメント書いて︕ →Flexboxを理解する必要があった
49. 結局のところ、その機能や実装⽅法、 裏側の技術を理解しないと 「分かりやすいドキュメント」は書けない
50. よく分かっていないままで 体裁だけ整った⽂章をなんとなく書くと 「読んだけどよく分からなかった…」となる 残念なドキュメントが⽣まれるだけ
51. LINEにはたくさんのプロダクトがあるので よいテクニカルライターになろうとすれば ⾃ずと⾊んな分野の技術を 積極的に学ぶことになり 技術⼒は衰えない（と思いたい）
52. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
53. 1. 仕様を理解するための技術の素養 2. 分かりやすい⽂章を書くスキル 両⽅あれば最⾼だけど どちらかと⾔えば1のほうが重要
54. もともとエンジニアをしていて ⽂章を書いたり、教えたりするのも好きだ︕ という⼈はきっと テクニカルライターに向いている
55. 1. テクニカルライターって何をしてるの︖何を書くの︖ 2. ドキュメントはどうやって書いてるの︖ 3. どんなメンバーで仕事をしてるの︖ 4. ドキュメントを書く以外にこんなこともしているよ 5. でもドキュメントを書くだけだと技術⼒が下がらない︖ 6. どんな⼈がテクニカルライターに向いてるの︖ こんな流れで話をしていきます
56. もともとインフラエンジニアだった私が LINEに⼊るまで知らなかった 1. テクニカルライターという職種があること 2. LINEにはテクニカルライティング専⾨の チームがあること についてお話ししてきました
57. https://linecorp.com/ja/career/position/806
59. 1: これだけ気を付けて書いてもらえると みんな幸せになるポイント2つだけ 2: 分かりやすいドキュメントを書く 「テクニカルライター」という仕事 3: Questions and Answers 11th March 2021 19:00-21:00 LINE Technical Writing Meetup vol.1
60. このイベントのアーカイブ動画は YouTubeでご覧いただけます https://www.youtube.com/watch?v=nmFVXJGiCxM
61. 61 https://line.connpass.com/event/207045/