ダメなドキュメント


作った人だけがわかっている、ダメなドキュメント

名詞が変わる
同じドキュメントの中で、「認証コード」「ユーザコード」「ユーザーID」「ログインID」と一つのことを指している名詞が複数登場する

テキストの箇条書きばかりで図がない

文章が箇条書きになっていなくて、のり弁状態になっている

ページ番号が打ってない
「上から7枚目・・」と言っている人がいる

項目に番号が振ってない
「真ん中からちょっと上あたりに書いてあります」と言うのでは、わかりづらい

詳細な内容が書いてない
項目だけが書いてあり、肝心なことは口頭で聞くことになる

2005年から毎日1話ブログ「しらべるが行く」

世界平和を実現 Copyrightしらべる 今日の更新 初出2004年11月 最終更新 2008/5/23