ページの本文へ

Hitachi

株式会社 日立インフォメーションエンジニアリング

設計ドキュメントの品質向上支援

設計ドキュメントの品質が、プロジェクトを成功に導く!

「複数の担当者で作成している」「開発に追われてドキュメントにかける時間がない」などの理由で文章や体裁が不統一になってしまい、設計ドキュメントの品質が思うように上がらない、ということはありませんか?

社外に納品予定のシステム設計書や機能仕様書などの品質向上を、マニュアル制作の経験が豊富な当社がお手伝いします。

お客さまの「困った!」を解決します

ドキュメントの文章や体裁が統一されていない

文章や体裁が統一されていないドキュメントは、読みづらいだけではなく、場合によっては誤って解釈されてしまうこともあります。
マニュアル制作では、文章や体裁の統一は必須です。マニュアル制作の経験が豊富な当社では、統一が必要な部分を漏れなく正確に摘出できます。
また、WordやExcelに精通したスタッフが検索方法を工夫したり、ツールを作成・活用したりすることで、該当個所を効率良く発見できるため、ページ数やファイル数の多いドキュメントにも対応できます。

開発業務に専念したい、ドキュメントの品質が上がらない

「社外に納品するドキュメントの準備が開発者の負担になっている」「ドキュメントの品質向上の専任チームを作ったが、修正個所の摘出漏れが多く、うまく機能していない」といったお悩みをお持ちの場合は、ぜひ日立インフォメーションエンジニアリングにご相談ください。
語尾の表現やフォントの統一などの基本的なチェックはもちろん、プロジェクト個別のドキュメント統一基準に基づいたチェックにも対応できます。
また、ドキュメントを出力紙で納品する場合の印刷やファイリングなど、修正に伴って発生する作業にも対応できます。

ここがPoint!

ドキュメントへの対応工数の削減を期待できます。

日本語としての品質向上をプロに任せることで、設計者が自らチェックするよりも作業効率が向上し、工数の抑止や作業期間の圧縮を期待できます。

設計者がシステム・製品の設計作業に注力できます。

ドキュメント構成、日本語表現、用語統一の面での品質を担保できるため、設計者はドキュメントの表現面の品質向上に労力を割かれることなく、システム・製品の設計作業に注力できます。また、設計書レビューの際も、システム・製品の仕様面の確認に時間を掛けられます。

ページ数やファイル数の多いドキュメントにも対応できます。

チェック項目によっては、ドキュメントの性質に応じたツールを作成・活用して効率的に漏れなくチェックします。そのため、ページ数やファイル数の多いドキュメントにも対応できます。

サービスの詳細

ドキュメントの文章や体裁をチェックします。

表現統一やレイアウトの統一という観点でチェックします。

  • 語尾の表現(ですます調、である調、句点の有無)のチェック
  • 見出し番号や図表番号の形式のチェック
  • 文章構成やカテゴリに応じた字下げ(インデント)のチェック
  • 文字のフォントやサイズのチェック
  • 英数字の全角・半角のチェック
  • 余白、ヘッダー、フッターのチェック

不適切な文章構成やわかりにくい説明をチェックします。

「わかりやすい説明」という観点でチェックします。

  • 冗長でわかりにくい文章のチェック
  • 複数の意味に読める文章のチェック
  • 文章間で矛盾する説明、整合性のとれない説明のチェック
  • わかりにくい文章構成のチェック

修正作業にも対応できます。

ご要望に応じて、チェック結果をドキュメントに反映する作業を実施します。また、ドキュメントの印刷やファイリングなどにも対応できます。ドキュメントでお困りのことがありましたら、お気軽にお問い合わせください。

事例

鉄道会社様向けシステムの設計ドキュメント(約33,000ページ)

サービス適用前
複数の担当者が何度も改訂していたことが原因で、ドキュメントの文章表現や体裁が不統一になっていました。鉄道会社様の品質基準を基にお客さまが統一作業を実施していましたが、基準が厳しいことやページ数が多いことが原因で統一作業を徹底できず、納品のたびに鉄道会社様から指摘を受けていました。また、ドキュメント対応の負荷が大きく、開発者の負担になっていました。
サービス適用後
鉄道会社様の品質基準に基づいたドキュメントの統一作業と納品準備を当社が担当。 納品後、文章表現や体裁の不統一に関する指摘が大幅に減少し、鉄道会社様から品質基準を満たしていると評価されました。また、納品準備もあわせて当社が担当したことで、お客さまのドキュメント対応の負荷が大幅に減少し、システム開発に専念していただけました。

官公庁様向けシステムの設計ドキュメント(約2,700ページ)

サービス適用前
複数の部署で作成されたドキュメントを集約したところ、システム全体に影響する用語の変更が漏れている、共通フォーマットの変更が適用されていないなど、官公庁様への納品の品質に達していないドキュメントが多数存在しました。
サービス適用後
用語の統一、共通フォーマットの適用などの統一作業を当社が担当。
納品までの期間が短いなか、全ドキュメントを官公庁様への納品に適した品質に仕上げることができました。

設計書チェックの例

設計書をWord形式でご提供いただける場合、設計書のチェック結果はWordのコメント機能を使用して記入します。指摘は一覧形式にもできるので、指摘一覧も返却します。

(改善前)・句点の有無が不統一、「である調」と「ですます調」が混在・ほかの見出しとフォントが異なる・全角・半角が不統一、文字のフォント・大きさが不統一・見出しレベルに応じた字下げになっていない(改善後)・区点を「あり」に統一、「である調」に統一・同じフォントに統一・半角に統一、文字のフォント・大きさを統一・見出しレベルに応じた字下げに修正

関連サービス

「設計ドキュメントの文章表現も改善したい」というお客さまには!

「製品・システムのマニュアルを作成、改善したい」というお客さまには!

「開発者の技術文書作成スキルをアップさせたい」というお客さまには!