CLOSE

いちばん良い1行を見つける近道(全1記事)

2021.07.02

Brand Topics

PR

「修正したい1行」に直接手を入れてはダメ! LINEのテクニカルライターが見つけた“良い1行”への近道

提供:LINE株式会社

テクニカルライティングをテーマにした技術者向けのミートアップ「LINE Technical Writing Meetup」。LINEでテクニカルライティングを専門としているメンバーが、もっと「わかりやすく伝える」ための知見を共有しました。ここでは堀越良子氏が「いちばん良い1行を見つける近道」というテーマで、良いタイトルの付け方について紹介しました。

LINEのテクニカルライターというお仕事

堀越良子氏(以下、堀越):私からは「いちばん良い1行を見つける近道」というお話をします。最初に今からみなさんにお話しする私の自己紹介をします。堀越と申します。LINEのDeveloper Content Teamというところに所属をしています。2020年の1月からLINEでテクニカルライターとして働いています。今までのざっくりとした職歴はこんな感じで、プログラマーとして3年、広報として4年、インフラエンジニアとして7年。2020年の1月からLINEでテクニカルライターとして働き始めています。

3年ぐらい前から個人的にインフラ系の技術書も書いて、今映っている猫のアイコンは、うちの猫にプレイステーション2のコントローラーを装着したアイコンです(笑)。

矢崎誠氏(以下、矢崎):これめっちゃ眼鏡に見えますよね。

堀越:すごく眼鏡に見えるんですけど、これコントローラーなんですよ。というところで自己紹介はさっくり終わりにして、今日私がお話しする内容はこちらです。

「いちばん良い1行を見つける近道」。どういうことかと言うと、こんなシチュエーションに心当たりはないでしょうか?

「ここの説明、いまいちわかりにくいから直したいんだけど、どうしようかな」と悩みながら、ちょっと書き足したり、消したり、ちょっと言い回しを変えたり、前後を入れ替えてみたり、「やっぱりさっきのほうがよかったかな」と元に戻したり、こんなふうに「いちばん良い1行」を探して気づいたら長時間悩んでしまっている。こんなことはないでしょうか。

今日はこういう「いちばん良い1行」を探すときにはこうやるといいよという方法を紹介していきます。「こうやるよ!」と、やり方だけ説明していくよりも実践的にやってみたほうがわかりやすいと思うので、お題を出します。

お題「LINE API Statusサイトオープンのニュースを出す」

お題! ちょっと前なんですけど、LINE API Statusというサイトがオープンしました。

これは開発者の方だったら「あぁ、あれね」とわかると思うんですけど、AWSのService Health DashboardやTwitterのAPI Statusみたいな感じで、開発者が「あれ? このサービス落ちているかな?」「なんかAPIが応答しない気がするけど今何か起きているのかな?」というのを確認したいときに、落ちているのか・落ちていないのかの状況を一目で確認できるサイトです。

我々は思いました。「LINE API Statusサイトがオープンした。すごくめでたい!」「LINE APIを使って開発している開発者のみなさんに、ぜひともこれがオープンしたことをお伝えしたい!」「そうだ、LINE Developersサイトでニュースを出そう!」と思いました。ここでニュースのタイトルをどうしようかなと悩んだんですね。

出てきた初案がこれでした。「障害状況やステータスを確認できるLINE API Statusを公開しました」。障害が起きていることがすぐにわかるし、何も起きていなくても今は安定稼働しているんだなというステータスもわかる。そういうLINE API Statusというサイトがオープンしたんだな。なるほど、伝わる気がする。良いタイトルだと思いました。

英語にしたらなんか変……?

でも前回テクニカルライターのお仕事を紹介した時にもお話ししたんですが、LINE Developersサイトは日本語と英語で同時公開しているんですね。書き終わったあとにチームの中で英訳をするんですけど、タイトルを英訳してみたら、なんか変だなとなったんです。それがこちらです。

日本語は「障害状況やステータスを確認できるLINE API Statusを公開しました」。それを英語にそのまましてみたら「LINE API Status site for checking outage status and status opened」に、なっちゃったんですね。……今矢崎さん笑ったな(笑)。

(一同笑)

矢崎:いやStatus、status、statusだなと思って(笑)。改めておもしろいなと思ったんです(笑)。

堀越:おもしろいですよね(笑)。「outage status and status opened」で終わっていると早口言葉みたいで。「障害状況やステータス」と日本語で並べるとそこまで違和感はなかったんですけど、英語にするとoutage status and statusで、完全に同じことを2回言っているねとなります。

これに気づいてから改めて日本語のタイトルを読んでみると、確かに障害が起きているというのもAPIのステータスの1つなので、障害状況やステータスと言ってしまうと同じことを2回言っていておかしいなとなりました。でも英訳してくれた別のチーム内のライターが、気を利かせてくれてこうしてくれたんです。

「『outage status and status opened』って2回言わなくても良いだろう」と言って、「日本語はいったんそのままで、英語のand statusを削っておいたぞ」としてくれました。優しい、ありがとうございます。このときこのまま行ってもいいかなとちょっとだけ思いました。日本語はそのままで、英語だけand statusを削るでもいいかなと思ったんです。けれど、すかさずレビューしてくれた別のテクニカルライターから、やっぱり日本語にツッコミが入りました。

すごく優しく、やんわり言ってくれているんですけど、「悩ましいんですが、障害『状況』と『ステータス』が同じ意味なので、『障害の概要やステータス』ではいかがでしょうか?もう少し据わりのいい言い回しがあれば良いのですが」。優しく言ってくれているんですけど、おっしゃるとおりです。「英語だけand statusを削ればいいよね」という話じゃなくて日本語のタイトルをちゃんと直すべきだなと反省しました。

というわけで「よし、腰を据えて良いタイトルを模索しよう」となりました。ということでより良い1行を見つける旅に出る(笑)。

矢崎:旅に出たんだ(笑)。

旅に出るときにやってはいけないこと

堀越:旅に出ることになるんですけど、そのときにやってはいけないことがあります。やってはいけないこととは、いったい何か。こういうのです。初案の「障害状況やステータスを確認できるLINE API Statusを公開しました」というところから「状況や」というのをササッと消して、さっきレビュアーに提案してもらった「障害の概要やステータスを確認できるLINE API Statusを公開しました」にサッと書き換える。

「やった! 第2案ができた! うれしい!」。これがダメです。いったい何がダメなのかというと、初案と第2案の比較ができないんですね。もう1回お見せするとこっちが初案で、こっちが訂正後の第2案です。

まだ初案と第2案の2つぐらいだったら、どこを入れ替えたのか、原案がなんだったのか覚えていられると思うんですけど、ここからあれこれ悩みながら書き足したり、消したり、少し言い回しを変えたり、前後を入れ替えたり、やっぱりさっきのほうがよかったかもなみたいなことをやっていると、「さっきのってどれだ?」という未来が待っています。

やっぱりさっきのやつがよかった気がするんだけど、さっきのがどんなのだったかがもう思い出せない。

より良い1行を求めて我々は旅に出たんですけど、そこでせっかくだんだん良くなっていったとしても、そのヒストリーと差分が見えないと最終的に良し悪しの比較ができなくなってしまうんですね。というわけで、今日の本題に戻りまして、「いちばん良い1行」を探すときにはこうやると良いよという、こういうときにオススメの方法をここから紹介していきたいと思います。

コピペしながら全部の案を並べていく

堀越:それは、直前の案をコピペしながら全部の案を並べていくという方法です。できればナンバリングもしましょう。今はこれ2つ、初案と第2案だけが出ているので、2つぐらいだったら「俺は上のほうが良いな」とか「下のほうが良くない?」みたいなので済むのですが、ここからさらに、こんな感じで案が増えていったときに「えっと、上から4つ目のやつよりは、その下の下のやつのほうがもうちょっとわかりやすいと思う」みたいな(笑)。

矢崎:下の下のやつ(笑)。

堀越:という感じになってだんだんツラくなってきます。「良いって言っていたやつはどれでしたっけ?」みたいになってくるので、こんな感じで書きながらナンバリングをしておけば、「自分は4のほうが好きだ」「自分は6のほうがわかりやすい」「3よりは5のほうが良いと思う」みたいに、どれというのがハッキリするので、とても便利です。

この全部の案を並べながら考えていく方法は、自分1人で考えるときも便利なんですが、誰かに「ちょっと5分付き合ってください」みたいに声をかけて、Zoomで画面共有をしながら頭を突き合わせて考えていくと、1人で考えているときよりも改善の螺旋階段みたいなものを上がっていく速度がすごく速くなっていって、5分ぐらい経つと「これが最高にわかりやすい」「これで良い」みたいな1文にすぐにたどり着けます。

今画面に表示されているのが、実際に矢崎さんとしゃべりながら考えたときのリストそのままなんですが、このときは確か最終的に「6だな」となって、6でリリースしました。こんな裏側を経て、公開されたニュースがこちら

「サービスの稼働状況を確認できるLINE API Statusを公開しました」。こういうタイトルになりました。再度並べながら見てみると、最初は「障害状況やステータス」と同じことを2回言っていたところから、「障害の概要やステータス」というものに行き、「概要やステータスって結局何だっけ?」と言ったときに、「安定稼働していることだな」となったり、「安定稼働しているのか、障害が起きているのかというを確認したいんだっけ?」と進んでいきました。

5つ目の辺りで「安定稼働とか障害が起きているというのは稼働状況という一言でまとまるのでは?」となっていって、「現在の稼働状況」。「稼働状況って結局何の稼働状況なんだっけ?」となって、「サービスの稼働状況」。「サービスの稼働状況だけで伝わるかな?障害状況も書いてあったほうが良いかな?」と言って7までいったんですけど、「稼働状況と言えば、稼働状況の中には障害が起きているという状況もインクルードされているので、6で良いだろう」という感じで進んでいきました。

こういうタイトルの裏側にそんなエピソードがあってリリースされたんだなと思うと、何気ないニュースもかわいく見えてきますね。矢崎さんもかわいく見えてきましたか?

矢崎:いや、別に。

(一同笑)

堀越:あれ?(笑)。

矢崎:でもいっぱい文章とかが出て、その時は7個並べたのかな? それで「6番が最高だよね」というのが、曖昧に「最高だよね」と言うんじゃなくて、この中ではこれがベストというのは納得感があったので、すごく良いやり方でしたね。

堀越:そうですね。もともと私はこのやり方を知らなくて、LINEに入ってテクニカルライターとしてやり始めたあとで、矢崎さんから、一緒に何かを直すときに「ちょっと待って!今のそれを消して書くんじゃなくてコピペして下にどんどん書いて」というのを教えてもらったんですよね。以来、その方法を取っています。

矢崎:良い方法。

堀越:良い方法。とても良い方法。やっぱり書いていて混乱してきて、ずっと見ているとゲシュタルト崩壊するみたいに、何が良いのかどれがダメなのか、結局どれが良いのかぜんぜんわからないとなってきてしまうのですが、そこまでの経緯が全部残されていると、冷静に比較をしたらやっぱりこれが良いよねと判断ができるので、並べていくのがオススメです。

やっぱりこういうニュースを1つ取っても、我々は自分1人で書いて誰のチェックも受けずに出すということはないのです。

さっきみたいにレビューしてくれて、忖度せずにスパッと言ってくれる別のテクニカルライターがいたりとか、それから機能のあるいはサービスの担当者さんがいたり、問い合わせを受けるサポートのチームがいたり、そういったいろいろなところと連携して、「こういう背景から生まれた機能なので、ここはもっと強調して説明したい」「こういう書き方をしてしまうと恐らくこういう懸念からユーザーの問い合わせが増えちゃうので、そこを解消できるようにこういう書き方をしてほしい」など。

いろいろな会話をしながら、こうやってタイトル1つ取ってもいろいろ考えながら一つひとつのドキュメントやニュースを出しています、という裏話でした。

いちばん良い1行を見つける近道

というところでまとめに入ろうと思います。「いちばん良い1行」を探すときには、元の1行に直接手を入れずに、コピペしながら全部の案を並べていきましょう。ナンバリングすると、なお良しです。テキストエディタでやれば、最初から行番号が出ているので、自分で番号を振らなくていいですし、楽かなと思います。以上が「いちばん良い1行を見つける近道」というお話でした。

緊張していたのか、すごい早く、半分ぐらいの時間で終わってしまった。最後にこんな感じでドキュメントを書いたりとか直したりとかを日々しているテクニカルライターというお仕事の求人情報は、こちらです。今表示されているここの画面から直接応募してもらっても良いんですが、堀越さんや矢崎さんにDMで相談の連絡をもらえると、リファラル採用枠になってお互いにうれしい何かが発生したりするようなので、ぜひ遠慮せずに。

矢崎:よろしくお願いします! なんか「テンション高くしたほうが良いよ」って言ってた。よろしくお願いします!

堀越:声も高くします。

(一同笑)

堀越:リファラル採用枠になってうれしいというのは裏側で、表側としてはいきなり応募というのはハードルが高いと思うので、「ちょっとカジュアル面談したいな」「テクニカルライターというお仕事について、もう少し2人から詳しい話が聞きたいな」みたいな、ということもぜんぜんありなので、連絡していただければと思います。

矢崎:お待ちしております。

堀越:お待ちしております! というところで「いちばん良い1行を見つける近道」でした。

続きを読むには会員登録
(無料)が必要です。

会員登録していただくと、すべての記事が制限なく閲覧でき、
著者フォローや記事の保存機能など、便利な機能がご利用いただけます。

無料会員登録

会員の方はこちら

LINE株式会社

関連タグ:

この記事のスピーカー

同じログの記事

コミュニティ情報

Brand Topics

Brand Topics

人気の記事

人気の記事

新着イベント

ログミーBusinessに
記事掲載しませんか?

イベント・インタビュー・対談 etc.

“編集しない編集”で、
スピーカーの「意図をそのまま」お届け!