SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

特集記事(PR)

あなたの仕様書は大丈夫? 日本語文のあいまい度診断ツール『ClearDoc』でドキュメントをチェック

ドキュメントの定量的な評価と開発生産性の改善

  • このエントリーをはてなブックマークに追加

 ウォーターフォール型の開発では、要件定義、設計、プログラミング、テスト、運用といった作業工程が時系列に進んでいく。開発当初に作成される要件定義や基本設計のドキュメントは、そのプロジェクトに関わる人たち全員が目にするため、そのドキュメントにあいまいな点や複雑な点などがあれば、後々の行程で問題が発生し、品質と生産性に影響する。この課題を解消するのが、株式会社シーイーシー PROVEQサービス事業部の開発した日本語文のあいまい度診断ツール『ClearDoc』だ。

  • このエントリーをはてなブックマークに追加

 ウォーターフォール型の開発では、要件定義、設計、プログラミング、テスト、運用といった作業工程が時系列に進んでいく。開発当初に作成される要件定義や基本設計のドキュメントは、そのプロジェクトに関わる人たち全員が目にするため、そのドキュメントにあいまいな点や複雑な点などがあれば、後々の工程で問題が発生し、品質と生産性に影響する。この課題を解消するのが、株式会社シーイーシー PROVEQ(プロベック)サービス事業部の開発した日本語文のあいまい度診断ツール『ClearDoc(クリアドック)』だ。

日本語の文を定量的に計測し、仕様書を可視化する

 システム開発における設計担当やアーキテクトは、仕様や要件を決め、仕様書や要件定義書、基本設計書、機能設計書などのドキュメント化を行う。このドキュメントは、プログラミングやテスト、運用といった後工程も含めたプロジェクト関係者全員が参照するため、あいまいな点や複雑な点があった場合、設計担当者に問い合わせがあり、内容の修正や再検討などの手戻りが生じてしまう。

 例えば、仕様書に「Aの場合BまたはC」という条件文があったとする。これは、「『AとB』、または『C』」と解釈できるが、もし設計者が「『AとB』、または『AとC』」と意図していたなら、プログラム構築の以降の工程に大きな影響がある。このように、読み手の感覚的な判断によって、設計の本来の意図とは異なる内容で理解/構築してしまう、思わぬバグが発生してしまうなどの可能性は未然に防ぎたい。

 システム開発におけるあらゆる工程での第三者検証サービスを提供しているシーイーシー社のPROVEQサービス事業部では、十数年に渡りテストサービスを行っており、バグや不具合が生じると、原因を報告してその原因を共有している。これらの経験の蓄積から、全体の不具合の中で3割~4割程度が仕様段階で十分検討されていなかったことや、抜け、誤認などに起因していることが分かったという。

 PROVEQサービス事業部が提供するサービスの一つに『ドキュメントあいまい度診断』がある。これは、仕様書や設計書を第三者の目で客観的に見て、ドキュメント中の誤理解を招きやすい文を容易に抽出し、明確な文にすることを目的としたサービスだ。ドキュメントを人が読んで感覚的に判断するのではなく、独自に開発した日本語文のあいまいさを計測するツール「ClearDoc(クリアドック)」を使って計測し、可視化した上で改善案を提案する。

 ClearDocでは、ドキュメントに書かれた日本語文のあいまいさ(複雑さ)を計測し、「あいまい度」という指数で可視化できる。複数の人が読んだ際にさまざまな解釈が生まれるような、一意にとれない複雑な文ほど、あいまい度が高くなるようになっている。体験版(15日間利用可能)がシーイーシー社のサイトで配布されているので、どういったツールなのかを無料で試すことができる。

次のページ
設計者のためのドキュメント計測

この記事は参考になりましたか?

  • このエントリーをはてなブックマークに追加
特集記事連載記事一覧

もっと読む

この記事の著者

森 英信(モリ ヒデノブ)

就職情報誌やMac雑誌の編集業務、モバイルコンテンツ制作会社勤務を経て、2005年に編集プロダクション業務やWebシステム開発事業を展開する会社・アンジーを創業。編集プロダクション業務においては、IT・HR関連の事例取材に加え、英語での海外スタートアップ取材などを手がける。独自開発のAI文字起こし・...

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/5406 2010/08/31 18:00

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング