top of page

【ドキュメント品質の向上】

プロジェクト毎にドキュメント品質がバラバラなので、統一したい、基準を明確化して品質を向上したい、チェックリストをブラッシュアップしたい等、色々な思いがあると思います。一般論から弊社で実施している対策までご説明致します。

ドキュメント品質について

目次

1.|ドキュメント品質とは

2.|ドキュメント検証のメリット

3.|ドキュメント検証の流れ

4.|まとめ


ドキュメント品質の向上についてご説明



1.|ドキュメント品質とは


開発ドキュメント(設計書・仕様書)を第三者の観点でチェックし、矛盾点や説明不足の箇所を指摘します。仕様書の抜け漏れ、矛盾、考慮不足や誤記を検出します。

上流工程で不具合を検出し、修正することで、後工程(テスト工程)での出戻りが大幅に削減することが可能です。

設計書に記載されている内容については、多くの人が確認する為、誤解を与えない文章を記載しているのですが、開発者の技量によりドキュメント精度がバラバラになるのと、ドキュメントのチェックまで手が回らないのが現状です。

難易度が高い機能、S/W修正の際に影響範囲が大きい機能を最優先で実施し、昔からのドキュメントを流用している場合は、一度ドキュメント検証されることをお勧めします。



2.|ドキュメント検証のメリット


ドキュメント検証のメリットとして、下記の5点があります。


2-1.コスト削減が可能

ドキュメントに必要な情報が少なく、作成者しか理解できない場合が多いので、詳細内容を具体的に追記したり、図示することで、誰が見ても理解でき、認識齟齬が無くなり、結果的にコスト削減に繋がります。


2-2.コミュニケーションロス抑制

コミュニケーションがうまく取れないプロジェクトは、プロジェクト遅延が多発し、認識齟齬による後戻りが発生します。ドキュメントを通してお客様やプロジェクトメンバーとの会話するため、品質は確保しておくべきです。


2-3.テスト設計品質向上

テスト設計書作成時は、設計書から作成するので詳細内容が記載されていた方が、より正確に確認することが可能ですし、ブラックボックスも明確化されるので、品質向上に繋がります。


2-4.テスト設計時のQ&A工数削減

設計書が明確化されていると質問事項が大幅に減ります。Q&A対応工数が多いと感じたら、ドキュメント品質改善をお勧めします。


2-5.プロジェクトの短期化

ドキュメント品質が良いと、高品質で短納期が可能になります。また雛形が出来ているので、ブラッシュアップすることでさらに品質が良くなります。

不具合の回収コストは、後工程になる程跳ね上がる為、上流工程でのドキュメント検証は必須です。



3. |ドキュメント検証の流れ


3-1.開発ドキュメントを確認します。 

・基本設計書

・要件定義書

・テスト計画書

・テスト設計書

・マニュアル

3-2.内容を確認します。

・ドキュメント全体の不整合 

ページによって同じことを違う用語で表現していないかを確認。

日本語の記述がバラバラ(です・ますの混在)。

・記述の漏れ/抜けが無いか。

開始、終了のフローが不明確になっていないか。

データの追加、削除に関する考慮が不足していないか。

データ連携がうまくいく作りになっているか。連携ミス発生時に気が付けるか。

・曖昧な記述が無いか。

読み手の状況によって解釈が変わってしまう表現になっていないか。

結論がわかる記載になっているか。


3-3.不具合一覧をして報告します。

・機能ごとに分類して報告します。



4.|まとめ


ドキュメント検証を実施することで、後戻りが少なくなります。また後工程での品質が改善されます。限られた時間内で対応する場合は、自分達でチェックリストを作成することで、ドキュメント品質を改善することも可能です。


改善する意識を持つことで、取り組み方が変わると思います。

#ドキュメント品質の向上

特集記事
最新記事
bottom of page