  |
を使用禁止させる。これが必要不可欠。これらの使用を許すと、見た目は整っているが内容は全く足りていない文書が大量に生産される。
よくあるのは、項目名と属性値が羅列されているだけで、文脈が全く伝わらないExcel方眼紙など。こういうものは、書いたやつの脳内でしか意味を成さない。たとえば、
| 管理対象期間開始日 | 文字列 | 32Byte |
| 登録日 | 文字列 | 32Byte |
| 利用開始日 | 文字列 | 32Byte |
こんな表だけ書かれても、読む人には何の情報も伝わらない。この表には、ざっと思い付くだけでも以下のような情報が欠けている。
図もやめた方がいい。もちろん、論理的に曖昧さ無く記述されたものの補足として図を載せるのはよい。しかし、馬鹿にドキュメントを書かせると、ただ単語を枠で囲ったり矢印で繋いだだけの図が出来上がる。その枠や矢印が何を意味しているのかは書いた本人にしか分からない。
この3つを禁止すると、ドキュメントを書くには、否が応でも曖昧さのない文章で記述するしかなくなる。事項と事項、文と文の関係性を明確にして記述せざるを得なくなる。これがドキュメント作成の最低ライン。
管理対象期間開始日は文字列で32Byteで、また、登録日に関しては文字列としており、こちらは32バイトである。利用開始日に関しては、文字列を用いること。前述と同じく、32バイトであ...
6
