連載
» 2009年02月16日 00時00分 公開

システム開発プロジェクトの現場から(23):本当は楽しいドキュメント作成 (1/2)

開発現場は日々の仕事の場であるとともに、学びの場でもある。先輩エンジニアが過去に直面した困難の数々、そこから学んだスキルや考え方を紹介する。

[宮本和洋,アクセンチュア・テクノロジー・ソリューションズ]

文書作りは好きですか?

 今回からこの連載を担当いたします、アクセンチュア・テクノロジー・ソリューションズの宮本和洋です。

 システム開発プロジェクトでは、さまざまな文書が作られます。私の連載ではこの文書に注目し、「文書ドリブン開発」という考え方を紹介したいと思います。

 文書ドリブン開発は私の造語です。「文書が作成されることにより、具体的な開発作業が進行していく」ことを意図しています。

 多くのITエンジニアは、文書作りではなく、動くものを作ることに楽しさを見いだすと思います。その作業の楽しさの中には、システムの設計に悩み、動作実証実験を繰り返す楽しさも含まれているのではないでしょうか。「この仕組みでちゃんと動くかな〜、どうかな〜」と試してみることが、ワクワクドキドキして楽しいという経験がありませんか?

 開発プロジェクトそのものの設計にも、「動くかな〜、どうかな〜」と同じような楽しみがあります。人の動きや情報の動きを設計して、開発プロジェクトを形作っていくという点ではモノ作りと似た醍醐(だいご)味があります。そして、文書作りの作業は、プロジェクトそのものの設計作業にほかなりません。

 どうですか? 文書作りに、少し興味がわいてきませんか?

認識共有のための文書の重要性

 システム開発プロジェクトで作成される文書には、大きく分類して以下の3種類があると考えられます。

文書の種類
内容
文書例
作成量
認識共有
特定の範囲の人間との認識を同じくするための文書。主に目的、作法、ルールなどを記述する ・計画書
・規約・標準文書
・技術ノウハウ集
情報伝達
ある人間の考えを別の人間に伝えるための文書。主に業務仕様、機能仕様、プログラム仕様などを記述する ・設計書
・テスト仕様書
証左
ある出来事が確かに起きた、起こしたという記録を残すための文書。主に事実、出来事、結果などを記述する ・テスト結果
・議事録
中〜多
表1 システム開発プロジェクトで作成される文書の種類

 システム開発の現場で作成量が最も多く、作成に最も時間をかけるのは、設計者から開発者への「情報伝達」を目的とした設計書だと思います。

 作成すべき設計書の種類やその記述レベル、記述項目は、「認識共有」の文書で定義されます。

 「証左」として残すものの定義についても、やはり認識共有の文書で決定されます。つまり、認識共有の文書の出来いかんで、プロジェクトの成否が決定されるといっても過言ではありません。

 認識共有の文書の量や内容は、プロジェクトの人数規模や工数規模によって調整されます。作成のタイミングは、「認識共有」をしたいと思われる都度です。

計画書を作ろう

 認識共有を推進するために、工程ごとに計画書を作ることを推奨します。プロジェクト規模の大小にかかわらず、作成する方がよいと考えます。

 各メンバーはこの計画書を読んで、それぞれの工程ですべきこと、ゴール、プロセス、アウトプットの意識を共有することになります。工程ごとのキックオフ資料と呼ばれているものと意味は同じです。

 仮に計画書が作成されなかった場合、成果物の記述レベル・品質は開発者によってバラバラ、仕事の優先順位は決まらず、タスクの遅延、共有すべき情報の漏れなどが発生し、プロジェクトの混乱を生むでしょう。

 計画書は行動指針にもなるため、できる限り実行性を考慮したものがよいでしょう。すべての物事が考慮され、綿密な計画が立てられたうえで記述されることが望ましいですが、プロジェクトは生き物であり状況は刻々と変化するので、ある程度は途中で変更せざるを得ません。

 以下に、普段私が作成している計画書の記載項目を紹介します。状況や工程によって記載内容は変化するため、それに合わせて書き換えています。このように、押さえるべきポイントを確実に理解しておき、あとはそのときの判断で追加や変更をしていけばいいと思います。

記載項目 概要
目的 工程のゴールと目的
優先事項 工程で最も優先すべき基準(品質、納期、コストなど)。各種の問題が発生した際の判断基準になる
事前共有知識 工程の従事者が事前に知っておくべきことと、目を通しておくべき資料の説明
作業手順 作業の流れ、インプットとアウトプット
作成する成果物 アウトプットの種類、管理方法を明確に指定。記述レベルに言及する場合も(連載次回以降で説明予定)
進ちょく管理方法 進ちょく管理の方法、進ちょく基準、管理文書の管理方法
工程スケジュール 大まかなマスタスケジュールとマイルストーン
コミュニケーションフロー 課題発生時の対応手順と情報共有の方法
工程完了条件 可能な限り定量的な指標による完了条件
品質管理方法 レビュー方法、成果物、テスト密度など
体制と役割 チームやプロジェクトの体制と役割、責任範囲
表2 計画書の記載事項
       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。