1. 無料アクセス解析

crossroad's Blog

Javaを中心にした技術ネタなど。

スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。
  1. --/--/--(--) --:--:--|
  2. スポンサー広告

ドキュメント作成...雛形は思考の足かせにもなる

ドキュメント作成について、日ごろ感じていることを書きます。

ドキュメント作成においてつきものなのが「雛形」です。
プロジェクトによっては全く雛形のないところもありますが、
厳格なところでは相当細かく雛形を作っているところもあります。

で、この雛形には一長一短があると思っていて、盲目的に
「雛形にあわせなければ駄目」「雛形にあわせておけば大丈夫」
と言うのはよろしくない
と思います。

と言うのは、雛形を意識しすぎることで「雛形にあわせてドキュメント
を作ること」が目的になってしまう
と思うからです。
当然、ドキュメント作成には問題を整理したり、明確化したり、
他の人とのコミュニケーション手段だったりと、「本来の目的」
があるはずなのですが、それを見失って雛形通りのドキュメントが
できれば安心してしまう
のです。

ユーザも含め、何か形になるもの...ドキュメントがあると内容は
ともかくとして安心してしまう
のが落とし穴です。
得てして、こういうドキュメントの内容は肝心な部分が抜け落ちていたり、
単に「それっぽいことが書いてあるだけ」になりがちで、後工程で
全く使えなかったりします。
そうなると、意味の無いものを作るのに労力を割いていたことになってしまいます。

そこで、ですが個人的には雛形は優先度を下げてしまって、フリーフォーマット
でドキュメントを作るのが良い
と思っています。
自分の頭の中にある情報・イメージをそのままドキュメント化します。
ExcelでもWordでもPowerPointでも、FreeMindでも、ただのメモでも
何でも良いので、ドキュメントの「本来の目的」にあわせて表現・理解しやすい
と思う形でドキュメント化
します。
当然、雛形がベターな表現方法であればそれを使います。
雛形が使いにくければ使いません。(使わざるを得ないことも多いですが)

特にテスト項目表なんかはよくある表形式よりも、マトリクスにして
テストの組み合わせパターンを整理したり、図示したほうがテストの主旨や
テスト項目の考え方がよくまとまります。

ドキュメント化してみてはじめて、テスト項目の漏れ抜けに気づくこともあります。
これはドキュメントが理解しやすい形で表現されていればこそ、だと思います。
ドキュメントの内容を直感的に理解できない、頭の中のイメージと直結しないと、
脳内でドキュメントと頭の中のイメージをマッピングするオーバーヘッドが
かかってしまい、問題に思考を集中できません


綺麗な見た目より、その内容こそがドキュメントの価値だと思います。
当たり前ですが、ただ形式的にドキュメント作成していると、案外そのことを
忘れていることが良くありますので要注意ですね。

関連記事
スポンサーサイト

テーマ:プログラミング - ジャンル:コンピュータ

  1. 2006/10/17(火) 01:17:03|
  2. ソフトウェア開発 一般
  3. | トラックバック:0
  4. | コメント:0
<<InstallPad | ホーム | ソフトウェア開発における人的リソースの使い方>>

コメント

コメントの投稿


管理者にだけ表示を許可する

トラックバック

トラックバックURLはこちら
http://bagineer.blog59.fc2.com/tb.php/49-8137e4a7
この記事にトラックバックする(FC2ブログユーザー)

プロフィール

crossroad

Author:crossroad
関西在住。男。
フリーランスのソフトウェアエンジニア。
エレキベース(Rock&Roll)とお酒が好物でございます。

カテゴリー

タグリスト

Java F1 フリーランス ベーシスト HARRY TheStreetSliders iPhone FX お酒 Seasar Maven eclipse Wicket マイホーム 野球 プロジェクトファシリテーション Rails Ruby UML お店 ソフトウェア Tomcat S2Flex2 jsf Teeda Eclipse タグライブラリ ajax タスク europa mylyn trac 

ブログ内検索

最近の記事

最近のコメント

最近のトラックバック

カレンダー

09 | 2017/10 | 11
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30 31 - - - -

月別アーカイブ

全ての記事を表示する

全ての記事を表示する

Twitter


RSSフィード

リンク

このブログをリンクに追加する

アクセスカウンタ

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。