HOME > 検証サービス・ツール > 仕様書・設計書検証 > ドキュメント検証

ドキュメント検証

ドキュメント検証 仕様書・設計書・マニュアルなどのドキュメントから読み手に誤解を与える箇所を抽出。システム開発の上流工程における『誤理解、抜け/漏れ、理解の難しさ』による認識不一致に端を発する手戻りを防止します。 仕様書の曖昧な記述は、読み手による理解の相違や、それらを解決するための負担を生み、ひいては成果物のクオリティにまで影響を与える重大な問題です。にもかかわらず、ドキュメント自体のクオリティ管理は、担当者の「感覚的な判断」によって行われてきました。ドキュメント検証サービスでは、文章を定量的に計測し、品質を可視化。担当者の感性や文章力に依存しないドキュメントの品質向上を可能にします。

ドキュメント検証活用例

  • 仕様書からあいまいさを排除することで認識不一致を防止
  • ドキュメント受け入れ基準として「あいまい度指数」を活用
  • 英文への翻訳前の日本語原文を改善することで訳文の精度をアップ

その他様々な活用法がございます。詳しくはお気軽にお問い合わせください。

こんな方にお勧めします

  • 開発プロジェクトを高品質化したい事業者様
  • 下流工程での対策は一通り実施されたお客様
  • 仕様に関するQ&Aの工数を軽減したいと考えているお客様

こんな悩みを解決します

  • 設計者と開発者の仕様認識のズレが開発工程の進捗に悪影響を与えている。
  • 仕様書の文章が作成者に依存してしまうことに問題を感じている。
  • 設計書をどのように改善すればいいか分からない。
この検証サービスについてのお問い合わせ

PAGE TOP

特長

仕様書・設計書などのドキュメントのクオリティを数値化

従来、担当者の「感覚的な判断」に任されてきたドキュメントのクオリティチェック。ドキュメント検証では、担当者の感覚や文章力に左右されない定量的な観点から文の質を計測し「あいまい度指数」で評価することで、ドキュメントの品質を可視化するサービスです。 ここでいう「あいまいさ」とは、認識のずれや誤った理解を生む冗長な文や、複雑な文を指しています。 こういった文では、複数の人が読んだ際に様々な解釈が生まれることがあります。読み手によって様々な解釈が生まれ、一意にとれない文ほど「あいまいな文」として「あいまい度指数」が高くなります。

あいまい度計測の例
原文 解析が終了しており且つ結果を表示している場合、またはデータをファイル出力している場合は、正常に処理が完了したことを示す。 あいまい度指数 4.693

文を分解し、あいまいな記述を排し再構成 ↓

修正案 正常に処理が完了したことを示す条件は以下とする。 あいまい度指数 2.412
解析が終了しており且つ結果を表示している場合 あいまい度指数 2.852
解析が終了しており且つデータをファイル出力している場合 あいまい度指数 3.165

不足している仕様項目を検出

仕様書に記載する項目は、開発時の指標になることはもちろん、検証工程の検証項目に影響を与えます。設計段階で十分な仕様項目を記載しておくことで、実装漏れや認識のずれによる手戻りを低減し、検証項目作成を効率化して検証漏れの防止につながります。 ドキュメント検証サービスでは、仕様書・設計書等の項目を「正常系」「準正常系」「異常系」に分類し、各項目がどの程度記載されているかを計測。要件定義・設計工程での十分な仕様項目作成をサポートします。

わかりやすい診断結果と充実のサポート

PROVEQの検証エンジニアがClearDocを使用して、検証対象のドキュメントを解析します。 解析完了後、「あいまい度診断結果」「診断レポート」と共に改善文案も提示。詳細設計時にも有用な、明確な意図を持ったドキュメントを作成するための施策をご提案します。課題点と改善案を確認することができるため、ドキュメントの品質改善作業を即座に開始していただけます。

ClearDoc計測結果と用語解析結果に基づく分析結果レポート

雛形やサンプルとの違い

仕様書を作成する際、雛形やサンプルを活用しようとして、該当のプロジェクトに当てはめることができず苦労した経験はありませんか? アプリケーション、Webサービス、組み込みシステムなどの開発は、コンテンツや開発現場の体制などにより大きな違いがあり、一般的なサンプルや雛形から分かりやすい仕様書を作成することは非常に困難です。無理にフォーマットに流し込むことで、記載すべき事項が漏れたり、読み取りにくい曖昧な文になってしまうこともあります。 該当の開発プロジェクトに合わせて仕様書を作成し、ドキュメント検証サービスを用いて曖昧な記述を排除することで、プロジェクトの内容にマッチした高品質なドキュメント作成が可能です。

PAGE TOP

サービスの流れ

STEP1 解析サービス

ドキュメント検証ツールによるあいまい度診断と、診断結果に基づいた分析・解析を行います。

ClearDoc計測結果と用語解析結果に基づく分析結果レポート
STEP2 ドキュメント改善のためのコンサルティングサービス

文書全体を通し、前後関係を含めて「正しい日本語」「技術的整合性」等の視野からコンサルティング。 課題点を指摘し、改善案を提示して、エンジニアよりコンサルティングを行います。

誤解を招く表記/抜け、漏れ/誤記/難文
STEP3 評価仕様書策定サービス

改善されたドキュメントを基に「評価仕様書」を策定、検証項目を作成します。 検証時の機能テストの設計や外注時の受け入れ基準としてご利用いただくことで、 仕様通りの開発を促し、製品の品質向上・納期短縮が可能になります。

改善された文書から評価仕様書を作成

ドキュメント検証」についてのお問い合わせはこちら

この検証サービスについてのお問い合わせ

PAGE TOP

類似の目的で使用できるサービス・ツール

ClearDoc

ClearDoc

テスト設計の観点から仕様書や設計書を精査。開発工程全体の改善に

仕様書・設計書検証

セキュリティ・コンプライアンス

システム機能検証

テスト自動化

テストプロセス改善

ソースコード検証

システム負荷検証

測定サービス・ツール

管理・監視・運用

開発者支援

認証審査