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?
  • アプリケーション内にあるヘルプのボタンやリンクは正しいコンテンツを表示している
  •  利用者の権限や種類に応じたコンテンツを表示している
  • ヘルプは新しいウィンドウに表示される

0 件のコメント:

コメントを投稿