SHOEISHA iD

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

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

特集記事(AD)

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

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

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

管理者のためのドキュメントのレビュー機能

 プロジェクトの管理者や品質評価の担当者は、プロジェクト全体に対して一貫したチェックを行うことが求められるものの、文単位の細かい部分まではチェックできない。ClearDocの計測結果には、仕様書の質を数値とグラフで確認できるビューも用意してある。これにより、ドキュメント中のどの箇所にあいまい度が高い文が見られるかなど、あいまい度の発生する密度や数などといった全体の傾向を確認できる。例えば、複数のチームでドキュメントを分担して作成をした場合、管理者が、各チームの担当箇所によるあいまい度の違いを確認するといった用途にも利用できるのだ。さらに計測と改善を繰り返した結果を蓄積していけば、現在作成しているドキュメントの品質改善状況を把握することもできる。

複数のドキュメントのあいまい度を比較

 計測結果の[ファイル間比較グラフ]では、ドキュメントのファイルごとの文の数、指定したあいまい度指数以上の文の数、あいまい度の密度を確認できる。

 [ファイル単位グラフ]では、ファイル内のどのあたりにあいまい度の高い文があるかが分かる。章単位で担当が違うような場合、あいまい度の高い文を書く担当を知ることもできる。

ドキュメントのチェックでQ&Aや手戻り工数を削減しよう

 設計担当から管理者、関係者までドキュメントをレビューすることができるClearDoc。シーイーシーのクライアントである携帯電話メーカーの組み込みソフトウエアの事例では、設計ドキュメントを計測し、あいまい度の高い順から10%の文を抽出し、修正をしたところ、Q&A数が70%、テスト時の不具合数も30%とそれぞれ減少し、複雑な文を書きやすいスタッフの特定・改善できるなどの効果を得ることができたという。

 組み込み系のシステムだけでなく、エンタープライズ系のシステムであっても、ウォーターフォール型ではなくアジャイル開発であったとしても、開発のためのドキュメントは必要だ。ClearDocによる計測で、関係者がとまどうことのない仕様書・設計書にして、品質や生産性を向上したいもの。ClearDocの体験版をダウンロードして、あなたの手元にあるドキュメントを計測してみてはいかが。

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

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

もっと読む

この記事の著者

森 英信(モリ ヒデノブ)

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

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

【AD】本記事の内容は記事掲載開始時点のものです 企画・制作 株式会社翔泳社

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

この記事をシェア

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

おすすめ

アクセスランキング

アクセスランキング

イベント

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

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

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

メールバックナンバー

アクセスランキング

アクセスランキング