2020.05.30良質な文章を書くのは簡単なことではありません。アウトプットの質を向上させるためには、そのための技術を学習しなければいけません。技術文章の場合、専門分野の知識を明確に説明できることが重要です。公開している技術文章をわかりやすく書くためのドキュメントを紹介します。英語のドキュメントですが、難易度は高くないため翻訳サービスなどを使えば問題なく読めます。ドキュメントのサマリーを紹介し、自分なりに大事だと思ったところをカテゴリ分けして補足していきます。Writing今回紹介するサイトはこちらです。公開している技術者向けのドキュメント作成指南書です。Engineersdevelopers.google.com大まかに次の2つで構成されています。それぞれはいくつかのドキュメントで構成されて扱っている各要素の説明をしています。各構成は最後にサマリーで締められています。それぞれざっくりと日本語訳にしました。これを読むだけでもそれなりにエッセンスを汲み取れます。文書を書くときに意識するべき全体的なポイントです。「audience」という言葉が頻繁に使われていました。読者を意識した文書を書くのが大事ということでしょう。良質なドキュメントは、「読者が必要としている知識や能力」と「読者の現在の知識や能力」の間を補填する物です。これに加えて、論理的にそれを届ける文章の組み立てが大事です。文章を組み立てるときに意識するべきポイントです。文書を書くときに使う言葉の選び方や使い方のポイントです。一貫した用語を使う曖昧な代名詞は避ける受動態より能動態を優先する不要な言葉は削除する受動態は主語が不明確になりがちなので使うのを避けます。能動態を使うことで誰が何をするのか、文章で伝えるべきポイントがぶれなくなります。日本語だと丁寧語や尊敬語なども受け取り方が違うものになる原因になります。用語の使い方も重要です。長い専門用語を略すときは最初にフルスペルを記載してカッコで略語を記載します。頻繁に出てくる用語は略語を使うとシンプルになります。リストの使い方リストを使うときに意識すべきポイントです。長い文章はリストにする順番が重要なときは番号付きリスト、そうでないときは箇条書きを使うリストの項目は並列にする番号付きリストの項目は命令形にする文書で使えるリストは2種類あります。箇条書き番号付きリスト項目の順番を入れ替えても問題ないときは箇条書き、順番が大事なときは番号付きリストを使うというのが選択のポイントです。各項目はそれぞれ論理的に同じグループに分けられるよう粒度を揃えます。図表を使うときに意識すべきポイントです。図表を作成する時には説明文を考える図に情報量を増やしすぎない画像に視覚的な注目点を作るきちんと図表の説明文を入れることで、伝えたいことが明確になります。丸や四角で図中の注目すべき部分を示すことで、見て欲しいポイントがはっきりとします。まとめこうして文書の書き方を改めて勉強してみると、普段意識できていないことが多くて発見が多いです。読みやすさと文書の内容が一致するとは限りませんが、どちらもそろってこそ良質な文書になります。日々意識してアウトプットの質を向上できるようにしていきたいです。アウトプットによる利点と具体的に意識すると良い点が項目ごとに数十個紹介されています。Library)バージョン4の勉強メモ。必須というわけではないけれど知っておいた方がいいかなという好奇心からのお勉強。参考書籍はこちらです。効率的に本を読むように意識づけしていく。読んだ本を紹介します。説明下手を克服したい人向けの本。したら伝わりやすい説明をできるかを意識できます。説明が下手な人の特徴考えた順番で話す理解度を合わせない主張が明確でない賢い=説明がうまい、ではない。下手な説明は逆に相手を混乱させる。コメントをキャンセルメールアドレスが公開されることはありません。※サイト次回のコメントで使用するためブラウザーに自分の名前、メールアドレス、サイトを保存する。プライバシーポリシーと利用規約が適用されます。SkillSmartHomeDiaryホーム検索トップサイドバータイトルとURLをコピーしました。