Tag Archives: Technical writing

LINE社内テクニカルライティング講座第3弾!不要な人に社内文書を読ませないコツ

こんにちは。Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。LINE社内で大評判のテクニカルライティング講座をブログにまとめてみたシリーズも第3弾になりました。(第1弾第2弾もぜひ読んでください!)

今回の記事では、以下のようにトピックが多く集まったときに「自分が書いたトピックを(その情報が不要な人に)読ませないためのコツ」を説明します。具体的には、順番に気を配ったり、情報の分類を気をつけたり、タイトルを工夫したり、という話をします。

LINE社内テクニカルライティング講座第2弾!1文では説明が終わらない文章を書くコツ

こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介しました。


今回の記事は、第2弾です。次のステップとして「1文では説明が終わらない文章をどのように組み立てていくとわかりやすいか」という話を、以下のような文章を例に説明していきます。

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

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

Write the Docs Prague 2018 Recap

こんにちは。Clova技術ドキュメントの作成・管理を担当しているTechnical WritingチームのJeongil Kangです。

私がテクニカルライティング(Technical writing)分野に携わってから、もう10年くらいになります。しかし、この記事をお読みの方の中には、テクニカルライティングという言葉を初めて聞くか、聞いたことがあっても果たしてどのような仕事なのかピンとこない、という方も多くいらっしゃるかも知れません。

韓国でも、大学にテクニカルライティング関連学科がないからか、この分野に携わる方はなかなか見当たらないのが現状です。特に韓国ではソフトウェア産業の特性から、設計ドキュメント、APIレファレンスといった技術ドキュメントを扱うテクニカルライターに出会うというのはなかなか難しいことです。

こうした厳しい環境においてテクニカルライターの多くは、業界の最新ニュースや仕事に関わる知識、戦略を手に入れるためにネット検索かチームメンバー同士の情報・経験の共有に頼っています。

ところが今回のWrite the Docsカンファレンス参加で、普段抱えていたそうしたニーズもだいぶ満たされたような気がします。今日はそこで見聞きしたことをブログ記事で皆さんに共有したいと思います。「Learning to love release notes」セッションはリリースノートの書き方について語られていたもので、テクニカルライターのみならず開発者にも有効な内容となっています。

 

API the Docs参加レポート

はじめに

こんにちは。テクニカルライターのSerizawaです。LINEには、エンジニアが最新の技術動向を把握できるよう、海外で開催されるカンファレンスに会社負担で参加できる制度があります。今回の記事では、その制度を利用して参加してきたAPIドキュメンテーションのカンファレンス「API the Docs」の様子をご報告します。

API the Docsは、テクニカルライター、API開発者、プロダクトオーナー、エバンジェリスト向けに年に数回世界各地で開催されている、APIドキュメンテーションに特化したイベントです。デベロッパーエクスペリエンスの重要な要素であるドキュメンテーションについて、最新のベストプラクティスやトレンドについて知見を共有し、意見を交換する場になっています。

LINE Developersドキュメントサイトのリデザインの話

こんにちは。LINEの開発者向けプロダクトのドキュメントを作成している、テクニカルライターのKenneth Lauです。すでにお気付きの方も多いと思いますが、2017年9月にLINE Developersサイトが大幅に更新されました。このサイトでは、LINEログインやMessaging APIのような開発者向けプロダクトに関するドキュメントや、アプリ管理用の開発者コンソールにアクセスできます。サイトの変更内容の概要については、サイトのニュース投稿「LINE Developersサイトのデザインが新しくなりました」を参照してください。

このブログ記事では、サイトを支える技術と開発者向けドキュメントの執筆プロセスに対する変更に焦点を当て、静的サイトジェネレータへの移行、この移行がドキュメント開発に与えた影響、そして今後の変更予定について述べたいと思います。まずは、LINE Developersサイトの簡単な説明から始めます。