Blog - LINE ENGINEERING

TAG ARCHIVES: Docs

「LINE Technical Writing Meetup vol.1」を開催しました！
LINE Engineering2021-04-01
こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。 2021年3月11日(木) に、「LINE Technical Writing Meetup vol.1」をオンラインにて開催しました。テクニカルライティングをテーマにした技術者向けのミートアップは初開催だったため、どの程度みなさんに興味を持ってもらえるかという心配もあったのですが、蓋を開けてみたら600人超の参加申し込みをいただき、当日もQ&Aの時間内では回答しきれないほどの質問をいただいて、大盛況のイベントとなりました。この開催レポートでは、当日の様子を動画や資料でご紹介していきます。 LINE Technical Writing Meetupってなに？セッション1：これだけ気を付けて書いてもらえるとみんな幸せになるポイント2つだけセッションの概要そもそも「分かりやすい文章」とは？ポイント1：名前を大事にしてほしい話ポイント2：あらかじめ読者との距離を近づけてほしい話動画（0:16:57〜）資料セッション2：分
LINE社内テクニカルライティング講座第3弾！不要な人に社内文書を読ませないコツ
yazakimakoto2020-09-24
こんにちは。Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。LINE社内で大評判のテクニカルライティング講座をブログにまとめてみたシリーズも第3弾になりました。（第1弾、第2弾もぜひ読んでください！）今回の記事では、以下のようにトピックが多く集まったときに「自分が書いたトピックを（その情報が不要な人に）読ませないためのコツ」を説明します。具体的には、順番に気を配ったり、情報の分類を気をつけたり、タイトルを工夫したり、という話をします。 ※図のカード1個が1トピックです。この図ではトピックが6個あります。全部読んでもらおうとしていませんか？おそらくほとんどの人は、ほかの人の文章を読むときに、必要そうな文だけピックアップして読んだり、タイトルだけで内容を判断したつもりになったりすると思います。検索エンジンで検索したときに、表示された内容だけで、文章の内容を推測して読むか読まないか決めますよね。そういう感じです。一方、自分が書いた文章は、ほかの人に1文字も逃さずに読んでもらえることを期待していないでしょうか？みなさ
LINE社内テクニカルライティング講座第2弾！1文では説明が終わらない文章を書くコツ
yazakimakoto2020-08-21
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介しました。前回の記事を簡単にまとめると「たくさんの文案を書いて、一番良さそうなものを選択することがとても大切です」という話を多くの例文を使って説明しました。まだ読んでいない方はぜひ読んでみてください。今回の記事は、第2弾です。次のステップとして「1文では説明が終わらない文章をどのように組み立てていくとわかりやすいか」という話を、以下のような文章を例に説明していきます。ここでは、このくらいの情報量の文章を「トピック」と呼びます。第2弾を最後まで読むと、「トピック」を書くときにどのような点に注意すると、わかりやすくなるかということが理解できます。早速、タイトルの話から始めましょう！タイトルを付けるまず、適切なタイトルを付けることの重要
LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
yazakimakoto2020-07-22
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介しています。どれくらい大評判だったかというと、2日間4セッションでしたが、エントリー数はのべ1000人を超え、実際の参加人数はのべ約900人。アンケートの回答は以下のとおり、のべ454人。そして、アンケートに答えてくれた全員が「期待以上に面白かった」または「面白かった」と答えてくれました。正直、「面白くなかった」「期待外れだった」が0だったことに驚きました。 ※ 1
LINEの社内には「テクニカルライティング」の専門チームがあります
LINE Engineering2020-06-17
こんにちは、Developer Contentチームのmochikoです。LINE株式会社でテクニカルライターとして働いています。今日は「テクニカルライター」というお仕事と、LINEにあるテクニカルライティングの専門チームについてお話しします。テクニカルライターという職種がありますテクニカルライターって何をしてるの？何を書くの？ドキュメントはどうやって書いてるの？どんなメンバーで仕事をしてるの？ドキュメントを書く以外にこんなこともしているよでもドキュメントを書くだけだと技術力が下がらない？どんな人がテクニカルライターに向いてるの？テクニカルライターという職種があります私はもともとウェブ制作会社のインフラエンジニアでした。とある技術書を書いたことをきっかけに「テクニカルライターとして一緒に働きませんか？」と声をかけてもらい、LINEへ転職するに至ったのですが、実はお誘いをいただくまで、テクニカルライターという職種があること LINEにはテクニカルライティング専門のチームがあることのどちらも知りませんでした。みなさんは知っていましたか？「ちゃんとドキュメ
LINE Developersドキュメントサイトのリデザインの話
Kenneth Lau2018-01-10
LINEプラットフォームの開発者向けドキュメントを担当しているテクニカルライターです。
こんにちは。LINEの開発者向けプロダクトのドキュメントを作成している、テクニカルライターのKenneth Lauです。すでにお気付きの方も多いと思いますが、2017年9月にLINE Developersサイトが大幅に更新されました。このサイトでは、LINEログインやMessaging APIのような開発者向けプロダクトに関するドキュメントや、アプリ管理用の開発者コンソールにアクセスできます。サイトの変更内容の概要については、サイトのニュース投稿「LINE Developersサイトのデザインが新しくなりました」を参照してください。このブログ記事では、サイトを支える技術と開発者向けドキュメントの執筆プロセスに対する変更に焦点を当て、静的サイトジェネレータへの移行、この移行がドキュメント開発に与えた影響、そして今後の変更予定について述べたいと思います。まずは、LINE Developersサイトの簡単な説明から始めます。 LINE Developersサイトについて LINE Developersサイトは、LINEログインやMessaging APIなどのプロダクトを利用する開発者向け

1