LINE株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。 LINEヤフー Tech Blog

Blog


LINEの社内には「テクニカルライティング」の専門チームがあります

こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。今日は「テクニカルライター」というお仕事と、LINEにあるテクニカルライティングの専門チームについてお話しします。

テクニカルライターという職種があります

私はもともとウェブ制作会社のインフラエンジニアでした。とある技術書を書いたことをきっかけに「テクニカルライターとして一緒に働きませんか?」と声をかけてもらい、LINEへ転職するに至ったのですが、実はお誘いをいただくまで、

  • テクニカルライターという職種があること
  • LINEにはテクニカルライティング専門のチームがあること

のどちらも知りませんでした。みなさんは知っていましたか?

「ちゃんとドキュメントを残すべきだ」という気持ちはあっても、どうしても開発だけが先行して、ドキュメントは置いてけぼりになってしまうことが多い中で、「ドキュメントを書くための専門のチーム」があるなんて…!さすがLINE…!という気持ちになりました。(もう入社してしまったので、結果としてすごく手前味噌な表現になっていますが、ここは入社前の素直な気持ちを綴っています)

テクニカルライターって何をしてるの?何を書くの?

とはいえ、「テクニカルライティングの専門チーム」がどんなことをしているのか、いまいち想像がつかないかも知れないので、「どんなことをやっているの?」を少しだけご紹介します。

LINEのテクニカルライターは、主に「社外の開発者向けにドキュメントを提供する」という仕事を行っています。

例えばエンジニアのみなさんが、自社で運営するサイトに「LINEでログインする」というボタンをつけて、エンドユーザがLINEのアカウントでもログインできるようにしてあげたい!と思ったとします。このとき「どうやって実装すればいいのかな?」がすぐに分かるよう、私たちは次のようなサイトでドキュメントを提供しています。

 

これらのサイトでは、基本的に日本語と英語のドキュメントを同時にリリースしています。(ドキュメントによってはさらに韓国語や中国語が加わったり、逆に日本でしか提供されないサービスの場合は日本語のみだったりします)

ドキュメントはどうやって書いてるの?

ドキュメントを書く流れは、エンジニアの皆さんがソースコードを書くときのフローとほぼ同じです。私たちは基本的にマークダウンでドキュメントを書き、ローカルの開発環境でデプロイして確認します。そして問題がなければGitHubのリポジトリへプッシュして、プルリクを作り、別のテクニカルライターやプロダクトの担当者がSandboxを見ながらレビューをします。無事にApproveがもらえてmasterブランチへマージしたら、Jenkinsがいい感じにデプロイしてくれてリリースとなります。リリースされたらみんなで「わーい」と喜びます。

先に日本語で書いてから英訳することもありますし、英語で書いてから日本語へ翻訳することもあります。日本以外に韓国にもテクニカルライティングのチームがあるので、韓国側で日本語に翻訳したドキュメントを、私たち日本のテクニカルライターがレビューする、という形で協力しあうこともあります。


新しい機能のリリースに合わせて数週間かけてたくさんのドキュメントを書くこともありますし、既存機能の変更点についてさくっと書いてその日のうちにリリースすることもあります。

どんなメンバーで仕事をしてるの?

2020年6月現在、テクニカルライティングの専門チームには8名のメンバーがいます。日本語と英語のテクニカルライターがおおよそ半分ずつですが、日本語と英語どちらも書ける人もいます。それからサイトの運用を担当しているフロントエンドエンジニアもいます。(ちなみにフロントエンドエンジニアのRomanさんと、テクニカルライターのMarshallさんが書いた「LINE DevelopersサイトをMiddlemanからVuePressへお引っ越しした話」はこちらで読めます。英語ですが、機械翻訳でも楽しく読めると思います)

日本、アメリカ、オーストラリア、ドイツ出身のメンバーが集まっているので、仕事上のやりとりや打ち合わせは基本英語です。ただテクニカルライターという職業柄、相手の理解度に合わせた伝え方をすることがみんな得意なので、英語が不得手でも生きていけます。(実際、私は英語を一切話せない状態で入社しましたが楽しくやれています)

また重要な打ち合わせには、社内の通訳翻訳チームから通訳者が入ってくれます。耳にはめたレシーバで、それぞれ同時通訳された内容を聞きながら会話ができるので安心です。2020年2月以降、テクニカルライティングチームが全面的にWFH(在宅勤務)になってからも、Zoomでの会議に通訳者が入ってくれて、まるで海外ニュースを見ているときのように、本人の発言は小さめの音量で、そこに被さるようにして同時通訳さんの声が聞こえるので、まったくもって問題なく打ち合わせができています。通訳翻訳チームのみなさん、いつもありがとう…!

ドキュメントを書く以外にこんなこともしているよ

社外向けのドキュメントを書く以外に、他部署からの依頼で文章のレビューをしたり、社内Wikiのページを直したりすることもあります。

また最近は、テクニカルライター歴20年の矢崎さんが「こんなことに注意して、こんな風に文章を書くとわかりやすいぞ!」と教えてくれる「わかりやすい文章の書き方講座」も開催しました。なんと900人以上が参加して、さらにアンケートで好意的な評価が100%だったという驚異の講座です。(この講座は本当に評判がよかったので、近日中にこちらのブログで同内容を公開予定だそうです →2020年7月22日に「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」が公開されました!)

でもドキュメントを書くだけだと技術力が下がらない?

ただ私はもともとがインフラエンジニアだったこともあり、自分で手を動かして実装せず、ドキュメントを書くだけになってしまうと、自分が「技術」から離れていってしまうのでは?という心配が少しだけありました。ですが結果としてそれは杞憂でした。

例えばLINEログインのドキュメントを書くためには、実際にコマンドを叩いてOAuthを理解する必要があり、Flex Messageのドキュメントを書くためには、実際にJSONを書いてみてFlexboxを理解する必要がありました。結局のところ、その機能や実装方法、裏側の技術を理解しないと「分かりやすいドキュメント」は書けません。よく分かっていないままでなんとなく書けば、「読んだけどよく分からなかった…」となる残念なドキュメントが生まれるだけなのです。

LINEにはさまざまなプロダクトがあるので、そこでよいテクニカルライターになろうとすれば、自ずと色んな分野の技術を積極的に学び、咀嚼し、そしてそれを分かりやすく伝える文章に落としていくことになり、技術力はあがります。エンジニアからテクニカルライターへの転身は楽しいぞ!

どんな人がテクニカルライターに向いてるの?

さて、ここまで読んで「ちょっとテクニカルライター興味あるな」と思った方もおられることと思います。もし開発の経験をお持ちで、文章を書くことにストレスを感じないのでしたら、あなたはきっとテクニカルライターに向いています。Zoomでのカジュアル面談なども可能ですので、気になった方はこちらの採用情報をご覧いただき、矢崎さんへお気軽にお声がけください。

テクニカルライター / Japanese documents」の求人詳細