CONTACT

BUSINESSコンサルティング事業

ソフトウェア開発文書診断サービス

ソフトウェア技術者が実開発業務において作成した開発文書を診断して、ソフトウェア技術者のドキュメンテーション力の育成と開発業務におけるドキュメンテーション活動の定着を支援します。
さらに、品質と生産性向上を導く開発文書ベースの開発プロセスの推進をサポートします。

特色

  • 現地現物の開発文書に対する文書診断を行います。
  • 診断結果を用いた教育と改善コンサルティングを行います。
  • 開発文書に基づく仕事の進め方の定着と、着実なドキュメンテーション力の強化、開発成果物の品質向上が期待できます。

ソフトウェア開発文書の文書診断

診断の対象

ソフトウェア開発の過程で出力される各種ドキュメント

診断の観点

1.開発文書に何を書くのか
完全性(合目的・正確・妥当)を調べる

ソフトウェア開発プロセスの品質確認

  • 記述の明確さからソフトウェア開発上の役割・構造化・根拠の明確さが分かる
  • 個々の作業の問題点、工程の問題点、プロセスの問題点を発見できる

2.開発文書をどのように書くのか
論理性・理解容易性・可読性・規範適合性を調べる

技術者として仕事の品質確認

  • 「あいまいな記述=あいまいな思考」を発見できる
  • 記述の正確さが品質に、明瞭さが生産性につながる

※1) 完全性・論理性・理解容易性・可読性・規範適合性:システム開発文書品質モデル(ASDoQ)の品質特性に基づいて診断します。

※2) 診断可能なドキュメントかを確認の上で対応します。専門的な技術内容(設計の妥当性など)の診断はしません。
(診断費用はご相談ください)

文書診断の適用例

適用例1

現在進行中の開発プロセス内で個々のドキュメントを診断し、治療につなげる。
レビューと連携することによって、各工程の作業品質を高める。

適用例2

過去のドキュメントを個別診断し、治療につなげる。
診断と治療を繰り返すことによって、反復演習として記述力と開発力を高める。

    • 文法、表記、表現の正確さ ⇒ 開発上の情報の正確さ
    • 読みやすさ ⇒ 読み手(次工程の作業者ほか)の理解しやすさ
    • ドキュメントとしての明確さ ⇒ 開発作業表現の明確さ

    ドキュメント品質の向上

    • ライティングスキルの向上
    • 開発力の向上
    • 工程作業品質の向上
    • 開発プロセス品質の向上
    • ソフトウェア製品品質の向上

文書診断
コンサルティングサービス

文書診断コンサルティングによって、開発現場における次の効果を期待できます。

  • 開発文書によって、見えないソフトウェアを可視化する
  • 目的に合った開発文書を書くことで、プロセスを可視化する
  • 結果だけでなく手段としての開発文書を作成することで、自身の仕事を可視化する
  • 開発文書の質を上げることによって、開発プロセスとソフトウェア製品の品質を上げる
  • 開発文書を用いた具体的な指導によって、設計力やプロセス推進力の養成につなげる
  • 開発文書をベースとした開発プロセスが定着し、開発プロジェクトの開発力が上がる

ご提案例

文書診断コンサルティングと研修を組み合わせた例

  • 【Step1】教育

    1日間(6時間)
    「ソフトウェアドキュメンテーション」研修
    ・基礎知識習得・意識付け

  • 【Step2】文書診断

    1.現地現物の開発文書に対する文書診断
    2.文書診断結果の分析
    3.開発現場に適合した教育カリキュラムや教育教材の作成
    ・教育の目的・研修構成案・現地現物ベースの実習教材 etc.

  • 「Step2」と「Step3」を
    繰り返し実施
  • 【Step3】教育

    半日間(3~4時間)
    「ドキュメントレビュー」研修
    実開発文書の診断結果を用いたレビュー実習
    受講者(の一部)が現在手掛けている開発文書の適用が最も効果的です。

その他、開発文書の体系化や、プロセス見直しなど、目的に応じて、文書診断コンサルティングを有効に適用いただけます。

PAGETOP