ツール
ドキュメント検証ツール ClearDoc

仕様書・設計書・技術文書のあいまいさを診断

こんな方にお勧めします
  • 開発プロジェクトを上流工程から高品質化 したい事業者
  • 大規模開発プロジェクトを検討中の開発事業者
  • 仕様に関する問い合わせを減らしたいと考えている管理者
  • オフショア開発を検討中の企業
  • 英文ビジネスメール作成に翻訳サービスを使用して
こんな悩みを解決します
  • 開発の工数削減と製品の品質向上が両立できない
  • 手戻りが多く開発効率が上がらない
  • 仕様書にどんな項目をどのように記載すべきかわからない
  • 設計書に重大な漏れがないか不安

ClearDocとは

仕様書や設計書などのドキュメントから
「あいまいな記述」「複雑な文章」を検出、
認識不一致を防止することで
プロジェクト全体の効率化と
品質向上をサポートするツールです。

ソフトウェア開発プロジェクト(コンシューマ/ビジネス向け製品開発や大型Webシステム構築など)の運営では、プロジェクトメンバーが参照する仕様書のあいまいな記述が様々なトラブルの元凶となります。ClearDocはこれらの冗長な文を抽出し、改善案を提案。誰にでもわかる端的なドキュメント作成をサポートします。更に、仕様書に不足している可能性のある動作条件について、仕様項目追加を推奨するコメントを表示。開発工程・検証工程に悪影響を与える「仕様漏れ」を上流工程から防止することにお役立ていただけます。

※後継製品cleardoxの提供を開始しました。

導入効果

  1. ドキュメント品質を向上することで
    プログラム品質向上を実現
  2. 日本語文の誤理解による
    考慮漏れ、解釈違いから生じる
    障害を未然に防止
  3. Q&Aや障害数を低減し、
    開発全体のコストを削減

その他様々なメリットがございます。詳しくはお気軽にお問い合わせください。

ClearDoc2.3.0新機能情報

新機能:レビューチェックリスト出力機能

  • 文解析を行った結果から、「条件文」と解析された文節を抜き出してExcel出力する機能です。
  • 要求仕様書に記載されている条件に対して、以降の仕様書、テスト設計書に漏れなく記載されているか、レビュー時のチェックリストとしてご活用頂けます。

活用シーン

  • ソースコード作成時の実装項目のチェック
  • テストケース作成時のテスト項目のチェック

レビューチェックリストサンプル

特 色

POINT 1

仕様書・設計書などの
ドキュメントのクオリティを定量的に評価

難解で複雑になりがちな仕様書や設計書の品質向上は、開発から検証に至るすべての工程に影響を与える重大な課題です。読み手によって様々な解釈が可能な「あいまいな表記」は、様々なトラブルを引き起こします。「設計時の意図と異なる解釈に立って構築が進行する」「検証時に正確な判断ができない」などのトラブルを未然に防止するために、ドキュメント自体の品質管理が必要です。 ClearDocは従来担当者の感性や文章力に依存していたドキュメントの品質評価を自動化。 「あいまい度指数」で定量的に評価することで、ドキュメントの品質管理を可能にします。読み手によって様々な解釈が生まれ、一意にとれない文ほど「あいまいな文」として「あいまい度指数」が高くなります。 曖昧で複雑な表記を検出し、改善案を提示することで、わかりやすく端的なドキュメントの作成を可能にします。 読み手によって様々な解釈が生まれ、一意にとれない文ほど「あいまいな文」として「あいまい度指数」が高くなります。曖昧で複雑な表記を検出し、改善案を提示することで、わかりやすく端的なドキュメントの作成を可能にします。

POINT 2

テストケースとなる文の抽出

本来、成果物で満たすべき要件をまとめたものが仕様書や設計書です。ClearDocは仕様書に記載されている項目の中で、検証項目として利用できる項目をピックアップ。検証時のテスト項目作成の負担を軽減します。

POINT 3

仕様の抜け・漏れの抽出を支援、
手戻りや仕様変更を防止

統計データ出力 イメージ図
拡大図を見る

※グラフはClearDocの統計値から生成したサンプルです。

仕様策定時点で項目の抜けや漏れがあると、必要な機能の実装漏れや、検証漏れの要因となり、さらに不具合や手戻りを引き起こします。検証時のテスト項目の元となることを考慮に入れて記載する項目を検討することで、必要な要件を盛り込んだ仕様書を作成することができます。 ClearDocは、仕様項目を「正常系」「準正常系」「異常系」に分類。記載されている仕様項目から、「追加を検討すべき準正常項目」を提示し、「異常系の仕様項目」の記載量を測定する機能を実装しています。仕様書の現状を把握することで、記載漏れに端を発する不具合や手戻りを削減、開発の効率化に貢献します。

POINT 4

ClearDocを利用したドキュメント検証の作業フロー

  1. あいまい度計測により、冗長な文を修正対象文として全文から抽出
  2. 検証時にテスト項目として利用可能な仕様項目と、それ以外の項目を分類する機能を搭載
  3. テスト項目作成時に追加検討されることが多い準正常系、異常想定項目を分類する機能を搭載 ※ 準正常系とは否定形で 書かれた仕様項目を指します。※ 異常想定とはエラーなどの具体的な用語で表記された仕様項目を指します。
  4. 検討されていない可能性の高い準正常系項目として利用できる条件節を抽出する機能を搭載
  • ※ClearDocの画面上で、「解析コメント」と項目分類を参考に修正可能
  • ※文節を解析して、条件記述の文節や準正常系動作仕様、異常系動作仕様などを分類
  • ※仕様項目の改善理由を解析コメントとして表示
  • ※後日でも編集を継続できるよう、解析済みの結果は解析データとして保存
  • ※仕様項目文を修正後、再解析可能

導入事例・ケーススタディ

キヤノン株式会社 様

導入前の課題

  • 仕様書に起因した障害の割合を減少させたかった
  • ドキュメントの品質を指標化して、客観的な分析を実施したかった

ClearDoc
導入で!

導入効果

  • 「導入・運用が容易」「現場にメリット」「フラッグシップのツール」という3点の条件満たしていた
  • あいまい度指数の算出によって、仕様書の品質が向上
  • 海外出荷用に翻訳する仕様書の品質向上にもつながった
オフショア開発会社 様

導入前の課題

  • 海外のエンジニアにとって、係り受けが複雑な文はそもそも理解し難い
  • 仕様に書かれている中での不具合に困っている
  • オフショア先送付前に、仕様書の日本語文を判り易くしたい

ClearDoc
導入で!

導入効果

ClearDocを利用して、仕様書の曖昧な記述をチェックして修正。 認識のズレが生じにくい、わかりやすく端的なドキュメントに。

グローバル展開会社 様

導入前の課題

  • 外国語に翻訳するのに、翻訳者に日本語文を理解させるところで時間がかかる
  • 正しい翻訳文にするのが難しい文が多い
  • 多言語翻訳前にマニュアルの日本語を端的な文にしたい

ClearDoc
導入で!

導入効果

ClearDocを利用して、仕様書の曖昧な記述をチェックして修正。 日本語のままでも伝わりやすく、翻訳時にも認識のずれが生まれにくい端的なドキュメントに。

パッケージベンダ会社 様

導入前の課題

  • 運用の順番や内容を間違えてしまう箇所がないか不安がある
  • 過去に運用誤りがあり、事前に予防したい
  • ユーザーからの問い合わせ対応マニュアルの日本語を明確にし、運用誤りを防止したい

ClearDoc
導入で!

導入効果

ClearDocを利用して、マニュアル中の曖昧な記述や複雑な文を抽出・改善。 スタッフ間での認識のズレを防止し、運営ルールの浸透を図る。

システム・サービス構成

動作環境

種類 解析対象言語 解析対象ファイルフォーマット
製品名 日本語 英語 Word Excel Text XML PDF Power Point HTML
ClearDoc × × × ×
種類 対応OS 対応Officeバージョン 推奨PCスペック
製品名 Windows
7
Windows
8.1
Windows
10
Office
2007
Office
2010
Office
2013
Office
2016
CPU メモリ
ClearDoc Celeron
DualCore以上
2GHz
以上
2Gbyte
以上

ライセンス形態

製品名 ライセンス体系 費用(税抜) 備考
製品名 年間ライセンス ¥498,000-

1ライセンス ・ノードロック(※)
※ご購入時にご利用されるPCのMACアドレスを申請頂きます。

6カ月ライセンス ¥250,000-
3カ月ライセンス ¥130,000-

※ご購入時にご利用されるPCのMACアドレスを申請頂きます。

お電話でのお問い合わせ(受付時間:平日9:00-17:45)

0120-057-232
携帯電話の場合:03-5789-2587

Webからのお問い合わせ

page top