ドキュメント整備とは

ドキュメント整備とは、貴社のプロジェクト管理や各開発工程で必要なドキュメント（テンプレート）を整備させていただくサービスです。

ソフトウェアの特徴として、目に見えないということがあります。
設計途中においては挙動を確認するすべはなく、実際にテストで動かしてみてプログラミングによる挙動がわかるといった具合です。
そのため、プロジェクト管理や各開発工程で作成するドキュメントの品質を測ることで、ソフトウェアのプロダクト品質を確保していくことが必要になります。
またプロジェクトの規模や開発手法によって、どこまでドキュメントを揃えるべきか、ドキュメントの項目をどのように決めるか、といったことも考えなければなりません。

上記のようなドキュメントに関する課題をクリアにするべく、弊社にて貴社のドキュメント類を整備させていただきます。

ドキュメント整備の概要

ドキュメント整備の概要は以下のとおりです。

プロジェクト管理系	要件定義・設計工程	テスト工程
プロジェクト管理に関わるドキュメント（テンプレート）を整備します。 具体的には… 　・プロジェクト計画書 　・レビュー記録表 　・ドキュメントチェック表	要件定義工程および設計工程に関わる必要最低限のドキュメント（テンプレート）を整備します。 具体的には… 　・要件定義書 　・機能設計書 　・画面設計書 　・DB設計書 　・バッチ設計書 　・帳票設計書	テスト工程に関わる必要最低限のドキュメント（テンプレート）を整備します。 具体的には… 　・テスト計画書 　・テスト仕様書 　・不具合管理表

こんな課題をお持ちの方をサポート

• システム開発で作成するドキュメントにおいて、定型のテンプレートがない
• ドキュメントがテンプレート化されていないため、項目をその都度考えて作成しなければならず効率が悪い
• ドキュメントがテンプレート化されていないため、ドキュメントの粒度や項目が人によって異なり、考慮漏れが発生している
• ドキュメントがテンプレート化されておらず定型でないため、レビューアへの負担が大きい。また、レビュー効率やレビュー精度の低下を招いている

ドキュメント整備が必要な理由

ソフトウェア開発において、ドキュメントを作成・整備する理由は大きく3点あります。

　①上流工程の工程間における成果物の整合性がわかるようにするため
　②各テスト工程のインプット情報を明確にするため
　③リリース後の改修時に影響範囲を特定するため

上流工程のドキュメントが揃っていない場合、テストのインプット不足により、網羅的で有効なテストが実施できないといった事態が発生してしまいます。
ドキュメントが存在しない、あるいはドキュメントが最新に更新できていなければ、記憶を辿るかソースコードを読みにいく以外に方法はなく、多大なムダが発生してしまいます。
設計書や仕様書などのドキュメントが存在しないことで、発注者とシステム開発会社との認識に齟齬が生じ、トラブルに発展するケースが実際に起こっています。

また担当者の変更や退職は、どの企業様にもかならず起こりうる問題です。
円滑な引継ぎには「必要なドキュメントがただしく整備されていること」が必要不可欠です。ドキュメントが整備されていれば、運用時のエラーや障害発生にも素早く対処でき、被害を最小限に抑えられます。

上記のようなトラブルを起こさないためにも、ソフトウェア開発におけるドキュメント整備は欠かすことのできない業務です。

ドキュメント整備で得られる効果

ドキュメントを整備することにより、以下のような効果が期待できます。

• ドキュメント作成の手間や工数を削減することができる
• 項目や記載粒度が均一化できるため、ドキュメント品質が安定する
• 項目や記載粒度の均一化により、レビューアへの負担が軽減され、レビュー効率やレビュー精度の向上につながる
• 必要とするドキュメントを一式揃えることにより、ドキュメントを体系的に管理することが可能となる
• ドキュメント品質の安定は、テストの網羅性担保につながるため、テストの有効性・効率性が向上する

なお「ドキュメント整備」は単独サービスとしても有効ですが、「開発管理規約策定サービス」と組み合わせることで、開発品質に対してより効果的な対策となります。

アウトプットイメージ（※一部）