ウォーターフォール型の開発では、要件定義、設計、プログラミング、テスト、運用といった作業工程が時系列に進んでいく。開発当初に作成される要件定義や基本設計のドキュメントは、そのプロジェクトに関わる人たち全員が目にするため、そのドキュメントにあいまいな点や複雑な点などがあれば、後々の工程で問題が発生し、品質と生産性に影響する。この課題を解消するのが、株式会社シーイーシー PROVEQ（プロベック）サービス事業部の開発した日本語文のあいまい度診断ツール『ClearDoc（クリアドック）』だ。
日本語の文を定量的に計測し、仕様書を可視化する
システム開発における設計担当やアーキテクトは、仕様や要件を決め、仕様書や要件定義書、基本設計書、機能設計書などのドキュメント化を行う。このドキュメントは、プログラミングやテスト、運用といった後工程も含めたプロジェクト関係者全員が参照するため、あいまいな点や複雑な点があった場合、設計担当者に問い合わせがあり、内容の修正や再検討などの手戻りが生じてしまう。
例えば、仕様書に「Aの場合BまたはC」という条件文があったとする。これは、「『AとB』、または『C』」と解釈できるが、もし設計者が「『AとB』、または『AとC』」と意図していたなら、プログラム構築の以降の工程に大きな影響がある。このように、読み手の感覚的な判断によって、設計の本来の意図とは異なる内容で理解／構築してしまう、思わぬバグが発生してしまうなどの可能性は未然に防ぎたい。
システム開発におけるあらゆる工程での第三者検証サービスを提供しているシーイーシー社のPROVEQサービス事業部では、十数年に渡りテストサービスを行っており、バグや不具合が生じると、原因を報告してその原因を共有している。これらの経験の蓄積から、全体の不具合の中で3割～4割程度が仕様段階で十分検討されていなかったことや、抜け、誤認などに起因していることが分かったという。
PROVEQサービス事業部が提供するサービスの一つに『ドキュメントあいまい度診断』がある。これは、仕様書や設計書を第三者の目で客観的に見て、ドキュメント中の誤理解を招きやすい文を容易に抽出し、明確な文にすることを目的としたサービスだ。ドキュメントを人が読んで感覚的に判断するのではなく、独自に開発した日本語文のあいまいさを計測するツール「ClearDoc（クリアドック）」を使って計測し、可視化した上で改善案を提案する。
ClearDocでは、ドキュメントに書かれた日本語文のあいまいさ（複雑さ）を計測し、「あいまい度」という指数で可視化できる。複数の人が読んだ際にさまざまな解釈が生まれるような、一意にとれない複雑な文ほど、あいまい度が高くなるようになっている。体験版（15日間利用可能）がシーイーシー社のサイトで配布されているので、どういったツールなのかを無料で試すことができる。
設計者のためのドキュメント計測
ClearDocは、計測対象のドキュメントファイルを読み込み、日本語の一文単位であいまい度を算出し、結果をMicrosoft Office Excel形式で出力する。読み込めるファイル形式は、Microsoft Office Word、Microsoft Office Excel、Microsoft Office PowerPoint、XML、そしてテキストファイルだ。ドキュメント中に図表や画像がある場合はそれを除外し、文のみを計測するようになっている。
通常、ドキュメントのレビューを行う際、最初から目を通して、各ページをチェックしていくが、何百ページもあるドキュメントの場合レビューをするだけでも時間がかかってしまう。ClearDocの計測結果では、あいまい度の高い文から表示され、その原因を推測し、対策を文で示するため、修正すべき箇所の判断をすばやく行うことができる。計測のための操作画面をいくつか紹介しよう。
計測対象と結果出力フォルダの選択
あいまい度を調べるには、まず計測対象のドキュメントがあるフォルダと、結果出力を行うフォルダを選ぶ。
計測対象ファイルの選択
計測対象フォルダの指定が完了すると、その中のファイル一覧が表示されるので、計測したいファイルを選択する。計測と同時にグラフの結果も出力したい場合は、［グラフも出力する］をチェックして［計測実行］をクリックする。
あいまい度の高い文から結果表示
計測結果は、Excel形式で出力され、ファイルを開くと、［あいまい度指数］の高い文から順にリストアップされる。
あいまい度の要因をガイド
文ごとに、あいまい度が高くなる要因をガイドする説明文も表示される。
原文の該当箇所を参照
［原文検索］では、計測結果ファイル内の文を選択することで、原文の該当箇所を参照できる。
［原文検索］で原文のファイルを開くと、該当箇所が選択された状態になる。
管理者のためのドキュメントのレビュー機能
プロジェクトの管理者や品質評価の担当者は、プロジェクト全体に対して一貫したチェックを行うことが求められるものの、文単位の細かい部分まではチェックできない。ClearDocの計測結果には、仕様書の質を数値とグラフで確認できるビューも用意してある。これにより、ドキュメント中のどの箇所にあいまい度が高い文が見られるかなど、あいまい度の発生する密度や数などといった全体の傾向を確認できる。例えば、複数のチームでドキュメントを分担して作成をした場合、管理者が、各チームの担当箇所によるあいまい度の違いを確認するといった用途にも利用できるのだ。さらに計測と改善を繰り返した結果を蓄積していけば、現在作成しているドキュメントの品質改善状況を把握することもできる。
複数のドキュメントのあいまい度を比較
計測結果の［ファイル間比較グラフ］では、ドキュメントのファイルごとの文の数、指定したあいまい度指数以上の文の数、あいまい度の密度を確認できる。
［ファイル単位グラフ］では、ファイル内のどのあたりにあいまい度の高い文があるかが分かる。章単位で担当が違うような場合、あいまい度の高い文を書く担当を知ることもできる。
ドキュメントのチェックでQ&Aや手戻り工数を削減しよう
設計担当から管理者、関係者までドキュメントをレビューすることができるClearDoc。シーイーシーのクライアントである携帯電話メーカーの組み込みソフトウエアの事例では、設計ドキュメントを計測し、あいまい度の高い順から10%の文を抽出し、修正をしたところ、Q&A数が70%、テスト時の不具合数も30%とそれぞれ減少し、複雑な文を書きやすいスタッフの特定・改善できるなどの効果を得ることができたという。
組み込み系のシステムだけでなく、エンタープライズ系のシステムであっても、ウォーターフォール型ではなくアジャイル開発であったとしても、開発のためのドキュメントは必要だ。ClearDocによる計測で、関係者がとまどうことのない仕様書・設計書にして、品質や生産性を向上したいもの。ClearDocの体験版をダウンロードして、あなたの手元にあるドキュメントを計測してみてはいかが。
