ドキュメントの書き方で注意すること

※気づいたことがあれば随時追記

  • 口語は使わない
    • 「○○しているかを」→「○○していることを」
  • 「だろう」は禁止
    • 「○○が良いだろう」→「○○が良い」
  • 平易な単語を使う
  • 図や表を織り交ぜる
    • 白黒印刷でも内容が理解できること
  • 「劇的」「一気に」といった「量」を表せない単語は使用しない
  • 原因⇔対応といった対になる部分はその関係で書く