初心者向け講座早見表
前回のコラムではドキュメント整備の重要性についてお話ししました。システム開発の現場におけるドキュメント整備とは、要件定義資料、外部設計書、内部設計書など、各フェーズ毎に発生するドキュメント整備が重要視されますが、忘れてしまいがちなのがドキュメント一覧になります。
最初からチームメンバーとして参加している人や、自分たちで業務を立ち上げた人たちは、何がどこに入っているのか、「このフォルダの中を見ればわかるよ」とよく言いますが、後から参加した人たちがフォルダを見たときに、どこから見たら良いのか、なかなかすぐにはわからないものです。
そこで、途中参加のメンバーやシステム運用者のためにも、ドキュメント一覧の作成を忘れないようにしましょう。
本来であれば、どのようなドキュメントが必要なのか検討するためにもドキュメント一覧を最初に作成するべきですが、実際には、そのような時間が無い事が多いと思います。
そこで、何らかのドキュメントを作成したときには、ドキュメント一覧にドキュメントのID、タイトルと簡単な説明書き、格納場所を記載し、分類分けしておくだけでも、後から何のドキュメントがどこにあるのかがわかります。
ここでポイントなのが、いろいろと記載項目を入れすぎないようにすることです。作成者や作成日は1度だけの記入で済むので、まだ良いのですが、更新者や更新日を記入するとなると都度更新となるため、記入する人への負担が大きくなってしまいます。そこで、ドキュメントのステータス（未作成、作成中、要更新、完成など）を項目として設定し、この項目に関してはシステム完成時にチェックシートとして更新すると良いでしょう。結局、開発中のドキュメントは常に更新されるものなので、開発中にステータスを更新しても常に「作成中」や「要更新」となるためです。
必要項目はそれぞれのプロジェクトにより、異なってくると思いますが、なるべく作成者の負担にならないようにすることで、ドキュメント一覧そのものがチームメンバーに浸透することが重要です。
また、開発スケジュールによっては、どうしても各フェーズの詳細なドキュメント作成に時間を割けない事があると思いますが、そのような場合でも、ドキュメント一覧には、「未作成」として本来書くべきドキュメントを記載することで、ドキュメント一覧の有用性がさらに上がります。
開発に必要な段階で作成できなかったドキュメントのタイトルや説明分を記載すると、開発への途中参加者が無駄にドキュメントを探さずに済みますし、開発後の納品前に整備するためのチェックリストとしての活用や、メンテナンスフェーズに入ってからドキュメント整備などの提案にもつながります。
それでは最後に、ドキュメント一覧作成のポイントについてまとめました。
◆ドキュメント一覧作成のポイント
・作成したドキュメントの分類、格納場所を記載
・項目を増やしすぎないように
・ステータス（未作成、作成中、要更新、完成など）を最後に記載
・未作成のドキュメントも記載
今回はドキュメント作成から一歩踏み込んで、ドキュメント一覧作成のポイントについてお話ししました。
本コラムが、読者の皆さんの日々の業務に役立てば幸いです。
（担当：小口 真己）
