2015年10月17日土曜日

ドキュメンテーションテスト(製品マニュアルのテスト)の観点[テスト技術][TC]

京都東福寺 2015-05-09


経緯

仕事で、ドキュメンテーションテスト(マニュアルなどの製品ドキュメントのテスト)をすることになりました。
ちょうどよいタイミングで良い記事があったので記録しておきます。

記事では、公式レビューにドキュメンテーションレビューを含める良い点と悪い点について説明していますが、ドキュメンテーションの質を上げたいのなら絶対やるべきだと思う。

ここでは、ドキュメンテーションテストの観点として、必要だと思うものを抽出してメモ書きしておきます。

次のようなカテゴリーに分けられています。

  • 機能
  • サンプルコード
  • 手順
  • リリースノート
  • ヘルプ


◆機能

Functionality within the doc system itself. Do links work? Do navigation items work? Does search work? Are there formatting issues anywhere?
  • マニュアルの機能が動作する
  • レイアウトや構成に問題が無い
  • PDF、HTMLファイルのハイパーリンク、しおりや目次などのナビゲーションが動作する


◆サンプルコード

Code samples in pages. Are the code samples accurate? Do the code samples correspond to the latest version? Is there a code sample for each of the main tasks?
  • サンプルコードに間違いが無い
  • サンプルコードが最新バージョンに対応している
  • 主要な機能に対してそれぞれサンプルコードが有る


◆手順

Accuracy of steps. For each task, are the steps to follow accurate? Are there any missing steps?
  • 操作手順は正しい
  • 操作手順に不足している手順は無い


◆リリースノート

Coverage of release notes. For each feature in the release, is the documentation updated appropriately? Do the release notes address each of the points of the release?
  • リリースノートに不足している記録が無い
  • リリースノートは適切に更新されている
  • アプリケーションのバグ修正や機能追加、既知の障害などリリースノートの記載に漏れが無い


◆ヘルプ

Is there a help button in the interface pointing to the documentation? Does the right doc set open for the right user role? Does the help open in a new window?
  • アプリケーション内にあるヘルプのボタンやリンクは正しいコンテンツを表示している
  •  利用者の権限や種類に応じたコンテンツを表示している
  • ヘルプは新しいウィンドウに表示される


2017年12月18日 追記
2017年12月21日 更新

実際のテストスイート

実際に考えてみたテストスートはこんな感じです。

テストスイート
テストケース
確認すること
機能
表示
マニュアルが表示されること
図の表示
図が正しく表示されること
※PDF文書では、図が擦れたり伸縮したりして不明瞭に表示されることがある。また、オンラインヘルプでは、図のサムネイルをクリックすると元画像が正しく表示される必要がある。
※テキスト形式のもので、図が存在しないのは対象外
画像の表示
画像が正しく表示されること
※PDF文書では、画像が擦れたり伸縮したりして不明瞭に表示されることがある。また、オンラインヘルプでは、画像のサムネイルをクリックすると元画像が正しく表示される必要がある。
※テキスト形式のものは画像が存在しないので対象外
参照先の確認
参照先のページやドキュメントが存在すること
検索機能の確認
検索したキーワードで検索結果が表示されること
スタイル
スタイルの適用
スタイルが正しく適用されていること(別途、チェックシートなどを利用する)
表記の統一
文章内の表記・表現は正しいか、統一されていること
図のスタイルの統一
図中のフォントは見やすい大きさか、また統一されていること
※テキスト形式のもので、図が存在しないのは対象外
レイアウトの統一
表紙、目次、本文がそれぞれ正しい形式になっていること
文章
操作手順
実装された新機能や変更された機能に関連した手順が正しいこと
表現
文章の文体が統一されていること。重ね言葉、助詞の連続、二重否定が無いこと
誤解の無い表現
文章に誤解を生む表現が無く、内容は一意に理解できること
誤字脱字
誤字・脱字が無いことを
用字・用語・項目
文章の用字・用語・項目が正しく、統一されていること
本文の記述と図が合致していること
※テキスト形式のもので、図が存在しないのは対象外
図中文章
図中文章が正しいこと
※テキスト形式のもので、図が存在しないのは対象外
サンプルコード
サンプルコードやサンプルコマンドに間違いがないこと
目次の表現
目次の表現は適切か、統一されていること
目次のレベル
目次のレベルは適切であり、統一されていること
索引
用語が索引に正しく登録されていること
品質ガイドライン
文書管理番号
文書管理番号が記載されていること
タイトル表記
ドキュメントタイトルが正しく記載されていること
日付
リリース日付が記載されていること
著作権
著作権の説明が記載されていること
商標
商標の説明が記載されていること
ライセンス
ライセンスの説明が記載されていること
・・・
※品質ガイドラインのテストケースは、会社や組織のポリシーやルールに応じて異なります。

0 件のコメント:

コメントを投稿