質の高い技術文書を書く方法 - As a Futurist...
大学や大学院で論文の書き方を鍛え上げた人たちには遠く遠く及ばないが、僕の様なはぐれもの1でも最近は Amazon 社内で文書の質が高いと評価してもらえるまでにはなった。Software Engineer として、コードでのアウトプットはもちろん大事だけど、文書のアウトプット(およびそれによって得られた実際のアウトプット)は同じだけ重要である2。今回は自分が最近どういうところに気をつけて技術文書を書いているのか、ということについて数年後の自分が忘れてないことを確かめられる様にまとめておく。 そもそも文書とは？ 英語だと document。ここで指す(技術)文書とは、人間が読む文体で書かれた技術に関連する情報、といったものだ。具体的に言うと以下の様なものを想定している: 新しいプロジェクトの骨子を説明する資料 会議の叩き台となる 1 枚ペラ 本番環境に変更を加えるにあたっての包括的な情報や具体
LINE社内テクニカルライティング講座第2弾！1文では説明が終わらない文章を書くコツ
こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。先日、このLINE Engineering Blogで「LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた」というタイトルで、1文を書くときに気をつけていることや手法について紹介しました。 前回の記事を簡単にまとめると「たくさんの文案を書いて、一番良さそうなものを選択することがとても大切です」という話を多くの例文を使って説明しました。まだ読んでいない方はぜひ読んでみてください。 今回の記事は、第2弾です。次のステップとして「1文では説明が終わらない文章をどのように組み立てていくとわかりやすいか」という話を、以下のような文章を例に説明していきます。 ここでは、このくらいの情報量の文章を「トピック」と呼びます。 第2弾を最後まで読む
LINE社内で大評判のテクニカルライティング講座で説明した内容をあらためてブログにまとめてみた
LINE株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。 LINEヤフー Tech Blog こんにちは、Developer Contentチームの矢崎です。LINE株式会社でテクニカルライターとして働いています。今日は、私が1文を書くときに気をつけていることや手法についてお話しします。 そして、この書き出しは、6月にmochikoさんが書いた「LINEの社内には「テクニカルライティング」の専門チームがあります」という記事のオマージュになっています。mochikoさんが書いた記事ですごいpvをたたき出したそうなので、人のふんどしで相撲を取ってみようという作戦で始めてみました。 この記事ではLINE社内で私が講師を務めた「LINE社内で大評判のテクニカルライティング講座」に沿って、わかりやすい1文を書くコツを紹介していま
Google社のテクニカルライティングの基礎教育資料がとても良かったので紹介したい - Qiita
はじめに エンジニアにとって、仕様書などの技術的な文章を書くこと（テクニカルライティングとも言います）は避けて通れません。ただ20年来多くのエンジニアの方々と同僚として接してきて思うことは、エンジニアの方の中には「文章を書く」ということに苦手意識がある方が一定数いるということです。 でもこの「テクニカルライティング」のスキルは、才能というよりは一種の「技能」だと思うんです。ある一定の原理原則を理解して実践を繰り返すことで、必ず一定レベルで習得できるものだと著者は信じています。 もしこのテクニカルライティングの原理原則をまだ体系的に学習したことがない、または過去学習したが改めて再学習したいという方に、お勧めのコンテンツを見つけたのでご紹介します。 https://developers.google.com/tech-writing Every engineer is also a write
「わかりやすい文章」が即書ける。“怒られ”の発生を防ぐビジネスメール術｜ココロ社
突然ですが、質問です。 “心穏やかに”仕事をするうえで、大事なことは何でしょう。 「安定した収入」「時間に追われない仕事内容」。そんなワードが頭に浮かんだ方も多いと思いますが、“即実践できるアクション”という視点で考えると……？ 私はズバリ、相手に怒られ（「怒られ」が発生し）ないコミュニケーションを心がけることだと思うのです。なぜか。怒られまくって心がザワつき、仕事どころじゃなくなったら元も子もないからです。 近年、ビジネスコミュニケーションの主戦場は、会話からメール（チャット）に移りました。日本でもここ最近、リモートワークが劇的に浸透したため、文章を書く機会が増えた方も多いでしょう。 つまり今、怒られないコミュニケーションを実践するなら、「怒られない文章」を書くことが必要なのです。 ただ、文章のみでは伝えられる情報量が少ないだけに、行き違いも多い。相手（読み手）主導のコミュニケーションな
5分で人を育てる技術 (25)“文書が上手いと言わせる”5つのテクニック(中篇)：芦屋広太一つ...
・先方より，当方が提示した処理画面の操作性が問題なので，見直してほしいとの要望があった。 ・上記については，当方にて検討することで了承いただいた。 ・また，先方から，社内の情報提供に使いたいので，弊社が提供するシステムの機能と画面イメージをメールで送ってほしいとの要望があった。 ・上記については，後日メールする旨返事をした。 ・東氏より，当方のシステムを使ってみたが，非常に分かりやすいとの感想があった。弊社のシステムは特に問題ないのではないかと思われる。 ・戸塚氏からは，上司に説明したところ，テストについてもよろしくお願いしたいとの指示があったとの話があった。 ・これに対し，当方からは，一緒に相談しましょうと回答した。 ・次回の打ち合わせは来週の水曜日くらいとの話になったが，その日は東氏の都合が悪いかも知れないとの話になり，結局，その場では決められなかったため，後日調整しましょうという話に
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
