テクニカルライティング

スタイル・ガイドを採用する 　企業や組織、大規模なオープンソースプロジェクトでは、ドキュメンテーションに既存のスタイルガイドを採用したり、独自のスタイルガイドを書いたりすることがよくあります。 スタイル・ガイドを採用するとは 文書やデザイン...

読者のために書く 　このコースでは、読者を定義することの重要性を繰り返し強調します。このセクションでは、文書を構成する手段としての読者の定義に焦点を当てます 読者のニーズを明確にする以下の質問に答えることで、文書の内容を決めることができる：...

読者に合わせた文書作成 　読者のニーズに応える文章を書くには、無私の共感が必要。自分の好奇心ではなく、読者の好奇心を満たす説明を作らなければなりません。読者に文書を合わせるために、どのように自分自身から一歩踏み出すのかが重要です。そのための...

読者が何を学ぶ必要があるかを見極める 　目標を達成するために、対象者が学ぶべきことをすべてリストに書き出す。場合によっては、そのリストには、ターゲットとなる読者が実行する必要のあるタスクも含める。 　読者は、ある順序でタスクを習得しなければ...

リストとテーブル 　優れたリストは、技術的な混沌を秩序あるものに変えることができます。技術系の読者は概してリストを好む。したがって、文章を書くときには、散文をリストに変換するようにする。 正しいリストのタイプを選ぶ テクニカルライティングの...

今日もテクニカルライティングです。それではいってみましょう。 単語 世界で最も優れた文章は主に単語で構成されている。 新しい用語や聞き慣れない用語を定義する 　対象読者の一部または全員にとって馴染みのない用語は、次の2つの戦術のいずれかを実...

テクニカルライティングでMarkdownの初級能力を身につける。とありましたので、ここでそれについてどうやって自分はやっていくかを箇条書き的に書いていきます。 VSCODEをインストールする。 sample.mdという何も書かれていないファ...

テクニカルライティングで、コンマ、括弧、コロン、エムダッシュ、セミコロンを適切に使用と出てきています。正直、何でしょうねと思いましたので、ここでまとめたいと思います。では行ってみましょう。 コンマ、括弧、コロン、エムダッシュ、セミコロンの適...

はじめに 　設計書というものを書く経験がなく、今回チャレンジさせてもらったが、書いたことないねと言われて、別の仕事をさせられた。そのときに、詳細設計書は、決められたフォーマットがあるが、その上の基本設計書になるとフォーマットとなる決められた...