投稿日時:

ドキュメント整備に関するコラムの第3弾として、ドキュメントのテンプレート整備に関するお話をします。システム開発の現場では、いろいろな会社やプロジェクト現場に初めて参画する際に、まずはプロジェクトの基本的な知識を得るため、過去のドキュメントを参照するのではないでしょうか。次に、ドキュメントを自分が書く時に、今度は同じ会社の他のプロジェクトなどから、自分が書こうとしているドキュメントと似たようなドキュメントが無いか、探そうとすると思います。

同じ外部設計書であっても、会社やプロジェクトによって、いろいろな形式のドキュメントが作られています。そして、それぞれの会社やプロジェクトの文化によって、ドキュメントへの記載レベルが異なっている事でしょう。そのため、新しくドキュメントを作成するときには、まず、「過去の良い例を探し、流用する」事によって、ドキュメント作成にかける時間をなるべく少なくしようとすると思います。

しかし、実際に過去の良い例を探そうとしても良い例が無い、探す人によって良い例の定義が異なる、記載レベルが中途半端なドキュメントしかなく参考にはできるが、どの様に書けば良いのかは結局、記載する本人任せ、などの例が少なくありません。

本来、ドキュメント整備をするにあたって、最も重要なのは書いた人の意図が、他の誰が読んでも正確に伝わる事ですが、結局ドキュメント作成する人のレベルによって、ドキュメントレベルが異なってきてしまう事は、よくあるお話しだと思います。

そこで、あらかじめ主要な(重要な)ドキュメントに関しては、プロジェクト開始時に、どのテンプレート(過去プロジェクトの良いサンプルを整理しておくだけでも違います。)を使うのか、どの様な書き方をするのか、メンバー間でテンプレートについて話をしてみる事をお奨めいたします。
メンバー間で同じテンプレートを使うことで、個人に依存したドキュメントの記載レベルにならずに、最低限のレベルは確保できるでしょうし、同じ書き方で書く事で、読み手の読解に関する効率化に繋がります。

もちろん、ドキュメント作成時にレビュー会を実施し、対面での説明なども重要になりますが、各フェーズの担当者間でドキュメントのテンプレートを共有しておくだけで、あらかじめドキュメントに記載されている内容以外の部分に注力した説明が可能となり、プロジェクト推進における効率化に繋がります。

隣に座っている人や設計者自身が開発する場合は、設計ドキュメントに頼らずに密な連携ができるので問題は少ないのですが、開発拠点が離れていたり、同じビルで開発フロアが異なるだけでも、誤読に繋がる事は多いと思います。テンプレートをあらかじめ共有しておくことで、誤記・誤読に関するリスクが減り、障害発生や再作業などの削減に繋がり、余裕を持ったプロジェクト推進に繋がります。

また、あらかじめテンプレートを準備することにより、最低限の必要なドキュメントが見えてくると思います。前回のコラム(見落としがちなドキュメント一覧)でもお話ししましたように、ドキュメント一覧作成は重要なポイントですが、ドキュメント一覧を作るときに、テンプレートが整備されているものか、新しくドキュメントを作らなければならないのかを一緒に整理しておくと、作成されたドキュメントのレベル感がわかって良いでしょう。

◆テンプレート整備のポイント
 ・ドキュメントの誤読を防ぐ
 ・ドキュメント作成にかける時間を短縮できる
 ・ドキュメントの記載レベルが一定となる
 ・最低限の必要なドキュメントが見えてくる

今回は意味のあるドキュメント整備に繋がるよう、誤読・誤記を防ぎ、ドキュメントのレベル感を統一するためのポイントとしてテンプレート整備の重要性についてお話ししました。最初にテンプレートについて話をする場を少し持つだけで、その後行程におけるプロジェクト推進の効率化に大きく貢献する事が、おわかりいただけたのではないでしょうか。

本コラムが、読者の皆さんの日々の業務に役立てば幸いです。

(担当:小口 真己