2017年12月19日火曜日

QAは製品マニュアルのテストをすべきか?(ドキュメンテーションテスト)[ソフトウェアテスト技術][TC]

我が家のサザナミインコ(2017年6月25日)
皆さん、年末でお忙しいと思いますが、私は咳がとまらず腹筋が痛くて上のインコさんみたいに縮こまっております。

さて、製品ドキュメントの品質は、ライターや仕様を考えたエンジニアに任せておけばよいのでは?と思う人も多いかと思いますが、今回は、QAの製品ドキュメントのテスト(ドキュメンテーションテスト)について考えてみました。※

ソフトウェアの機能が期待どおりに動くことは、当たり前品質の部類ですが、マニュアルの記載動作がソフトウェアの動作と等しく書かれていることも同じように当たり前品質です。

私が働いている日系のエンタープライズ系ソフトウェア業界では、基本機能だけでなく、詳細動作も正しく動くこと、UI周りのリソース文字列やドキュメントの手順の記載も正しい書かれていることが当たり前となっています。とりあえず、目的が達成できていれば満足というユーザーは少ないのが現状かと思います。

前提

テクニカルライターやテストエンジニアのような役割が明確に設定されていない開発組織では、基本的に開発者がソフトウェアに付随するドキュメントを制作することが一般的だと思います。また、制作を外注に出している会社も多くあるでしょう。大規模な組織では、組織内包型のテクニカルライターやQAを持ち、ライターが原稿を書き、その後で開発チームやサポートチームが査読する形をとる場合もあると思います。

ここでは、次のような前提で考えています。
  • 製品ドキュメントは、テクニカルライターが仕様書や実際に動いているものを試しながら書きます
  • ドキュメンテーションテストの目的は、製品に付随されているヘルプやマニュアルの内容が正しく書かれてあり、正しく動作・表示されることを確認すること


    QAもドキュメントのテストをしよう

    QAが、次の理由からドキュメンテーションテストをすべきと考えました。
    • マニュアルも製品の一部である
    • QAは、製品の仕様や手順を詳しく知っている存在である
    • 目につく間違いはちょっとしたことでも品質を下げやすい


      ●マニュアルも製品の一部である

      QAは、製品の品質に対して責任を持つプロフェッショナルです。製品の中には、当然、ソフトウェアに付随するドキュメントも含まれます。また、コンテキストベースのヘルプシステムでは、ソフトウェアの動作に応じてテキストを表示するような仕組みも実装されています。


      ●QAは、製品の仕様や手順を詳しく知っている存在である

      テストケースを作成するには、テスト対象のソフトウェアの動作や手順に熟知しているはずなので、マニュアルの説明や手順が正しいかどうかをチェックするには適任です。


      ●目につく間違いはちょっとしたことでも品質を下げやすい

      ちょっとしたことでも、目につく間違いに対してユーザー(特にシステム運用や管理者の人)は非常にセンシティブです。そういったみっともないものをいつまでも放置したり気が付かなかったりするメーカーは、信頼できないと考える人も多いのでは無いでしょうか?

      メーカー側としても、簡単な記載漏れや記載誤りで低品質と評価されることは避けたいところです。


      具体的にどんな観点でテストをするの?

      QAが具体的にどんなテストを実施しているかは、以前書いた記事「ドキュメンテーションテスト(製品マニュアルのテスト)の観点」を更新しましたので、こちらを読んでみてください。




      この記事は、「ソフトウェアテスト Advent Calendar 2017」用に書きました。

      ※「製品マニュアル」という用語をタイトルに入れていますが、製品マニュアル以外にリリースノートや手順書など製品に含まれるドキュメントも内容に含まれています。日本だと「マニュアルテスト」という用語を使うことが多いようですが、英語表記で"manual test"となり、「手動テスト」という意味になり微妙です。また、欧米でだと"documentation test"が一般的なのであえて「ドキュメンテーションテスト」としています。

      1 件のコメント:

      1. 「マニュアル査読」はソフトウェア検査部門が行う製品検査作業の中の(大きな)ひとつでしたよ。
        ご参考(読みづらくてすみません):
        富士通のソフトウェア品質保証活動, 標準化と品質管理, Vol.41, No.2, 1988
        http://a-lifelong-tester.cocolog-nifty.com/publications/Software_QA_activities_at_Fujitsu.pdf

        返信削除