一ヶ月程前に、ちらっと読んだ「WEB+DB PRESS Vol.25」に、ソフトウェア開発におけるドキュメント作成の記事が載っていました。あまり細かいところまでは読んでいないのですが、


「ドキュメント作成では、読み手が読みたいことだけを書くようにしないさい」


ということが言われていました。
 となると、「クライアント向け」「開発者向け」と、ほとんど同じ内容のドキュメントを2倍作成する必要が出てくるわけですが、そんな効率の悪いことはしていられません。


 そこで、私が最近研究しているのが「レイヤー機能を利用したドキュメント作成」です。
※ここで言うレイヤー機能というのは、Photoshopなどのレイヤー機能のこと。


例えば、



画面の機能・詳細設計仕様書の場合:


 レイヤー0:画面イメージ
       画面の概要説明
 レイヤー1:表示項目の説明
       コントロール操作時の機能説明
 レイヤー2:画面表示項目とDB項目の対応
       コントロール操作時の動作
       (起動するプロシージャ名など)


というドキュメントを作成し、参照する人に応じて提供するレイヤーを変更する。


 クライアント:レイヤー0、1


 開発者:   レイヤー0、1、2



 でも、レイヤー機能があるアプリケーションがあんまり無いんですよね。
 MS Officeだと「Visio」。OpenOfficeだと「Impress」(プレゼンソフト)にレイヤー機能があるようです。


# WYSIWYGとレイヤー機能って相容れないような気もするしな


※この日記の内容は、2005/03/14に仲間内のメーリングリストに投稿したメールを一部修正したものです。