KAOS (60) 書き方を定めた自然言語による文書 (4.2, 4.2.1-1)

文書の書き方については,これまでも,さまざまな取り組みがなされてきている.最初の紹介は心得である.細かな規則を定めることによって,良い文書とする努力である.先ずは,その内容を紹介する.

  • 誰が読むのかを考えてから,書く
  • 書く前に,何を書こうとしているのかを説明する
  • 動機を最初に書き,まとめは後にする
  • 全ての概念は,使用する前に定義しているかを確認する
  • 次のことを問い続ける「これは読者に理解可能か.読者はこの点で迷わないか.詳細度のレベルは適切か.ここに書いていることは,他の場所の記述と関係していないか.十分に記述したか.違った風に解釈されることはないか.他に単純な言い回しはないか」
  • 一文に,2つ以上の要求・前提・問題領域の特性を記述していないか
  • 文を短くする
  • 規範的文には,「であること(shall)」を用いる.望むことには,「であることが望ましい(should)」を用いる.
  • 不必要な専門用語や略語を避ける
  • 抽象的な文を明確にするために,分かりやすい例をつける
  • 先行する文を詳細化する項目は,中黒付きリストとする
  • 複雑な項目間の関係を示すために,図と説明をつける
  • 視覚的な全体像と,重要な点を説明するために,図を用いる
  • 関連する事実は,表によって示す
  • 量的情報を関連づけるために式を用いる
  • 複雑な(入れ子や曖昧さを持つ)条件を組み合わせることは避ける

正直に云うと,こうした注意事項を書くことができる勇気がうらやましい.おまえはどうなのだ,といわれると困る.

しかし,彼の文章は明快で,とうぜんその資格があると思う.

(nil)