初心者向け講座早見表
ドキュメント整備に関するコラム第4弾は、ドキュメント作成に対する意識についてお話しします。
前回のコラムではテンプレート整備の重要性についてお話ししましたが、今回はテンプレートに頼りすぎることの問題点に触れながら、ドキュメントはどの様に作成されるべきなのか、考えてみたいと思います。
前回のおさらいになりますが、テンプレート整備は、ドキュメントの誤読を防ぎ、作成にかける時間の効率化に繋がり、品質を一定にし、最低限の必要なドキュメントがあらかじめ見えてくることがポイントとなります。
しかし、テンプレートがしっかりと整備されてしまえばしまうほど、テンプレートに頼りすぎたドキュメント作成になってしまい、本来伝えなければならない要件や設計が伝わらないドキュメントとなってしまう事があります。
具体的な例を挙げながらお話しましょう。
画面設計を示す設計ドキュメントをテンプレート化するときに、画面上のボタンの表示/非表示に関する条件式の記載場所はテンプレート化できますが、画面上に表示されるボタンの条件が1つや2つではなく複数の要因による複雑な条件となってしまった時に、無理にテンプレート上で記載しようとして、わかりにくいドキュメントになってしまう事があります。
本来であれば、別にページを設けてマトリックス表などを作成すると、わかりやすい内容になるところですが、テンプレートに合わせなければいけない、という考えに囚われすぎると、本来伝えるべき内容が伝わらなくなってしまうのです。
また、あらかじめテンプレートを決めてしまう事で、テンプレートとして準備されたドキュメントだけ作ればよいという勘違いをしてしまうのも問題です。システム開発のプロジェクトに同じプロジェクトは2つとありません。そのため、他のプロジェクトのテンプレートやドキュメントは、最初にテンプレート展開するときには、とても重要な参考資料となりますが、プロジェクト別に必ずテンプレートでは表せないドキュメント作成が必要となります。
そのため、テンプレートを展開することで、作業効率化や最低限の品質を保つことはできますが、テンプレートは意思疎通のための共通言語となる土台と考え、テンプレート上に表すドキュメントは「誰に何を伝えなければならない」のかを常に考えながら書くべきものです。
「誰に何を伝えなければならない」ドキュメントなのかを考えるときに、漠然としてしまって難しいと思うのであれば、チームメンバーの誰に伝えるべきものなのか、クライアントの誰に伝えるべきものなのか、具体的な人を考えながら記載するだけでも違ってきます。その伝えるべき相手をイメージしながら書く事で、何を伝えなければならないのかが明確になる事でしょう。
明確な誰かをイメージする事から、ステップアップすると、多数の人に対するわかりやすいドキュメント作成に繋がります。
これまでのお話からも考えられるように、テンプレートというのは、常に変化していくべきものになると思います。もちろん1つのプロジェクトや1つのフェーズの中でテンプレートを変えていくのは、本来のテンプレート整備のメリットを無くしてしまうので、問題ですが、プロジェクトやフェーズが進むタイミングにテンプレートを変更させるのは、チーム全体のドキュメント品質の強化に繋がります。
テンプレートの改善までは難しくても、これまでのテンプレートを使った良い事例をチーム内で展開するだけで、ドキュメント品質の強化に貢献できます。この様にプロジェクト実施中における、ドキュメント整備にかける時間を少しだけ意識することで、より良いドキュメントを残すことができるでしょう。
◆ドキュメント作成に対する意識
・テンプレートに頼りすぎない
・テンプレートは意思疎通のための共通言語
・誰に何を伝えるべきドキュメントなのかを意識にする
・テンプレートは改善していくべき
今回は、前回のテンプレート整備に関する重要性の背後に潜む、システム開発の現場における落とし穴についてお話ししました。プロジェクトを進めるうえで、テンプレート整備をする時には、テンプレートに対するチームメンバーの意識づけも重要なポイントとなる事が、おわかりいただけたのではないでしょうか。
本コラムが、読者の皆さんの日々の業務に役立てば幸いです。
（担当：小口 真己）
