2017年12月19日火曜日

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

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

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

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

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

前提

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

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


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

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


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

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


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

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


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

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

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


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

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


      2017年12月17日日曜日

      Windows ユーザーインターフェイスの公式 デザインガイド[TC][Windows]



      Windows 8以降、UIが頻繁に変わってついていけない状態でしたが、Windows 10のUIガイドがいつの間にかリリースされていたので記録として残しておきます。

      UIのガイドは、ユーザーインターフェイスの基本コンポーネントの名前や配置などを明確にして、デザイナーや開発者と共有するために提供されていると思っています。

      マニュアルライターの場合、手順を書くときにどういう名称を使うべきかを決めるときに調べることが多くあるため便利です。たとえば、私の場合、「スクロールバー」という用語を忘れがちで、「スライダー」とか「ホリゾンタルバー」とかだったっけかな…みたいに名称が分からないときに、公式ガイドを調べて何を使うか決めます。

      また、テストケースを作るときに手順のステップを書かなくてはいけませんが、そういったときに適切な用語を使いたいですね。

      ちなみに、Windows 10のUIガイドをダウンロードして見てみましたが、592ページに及ぶ壮大な夢物語でありました。PDFで公開するのならせめて「しおり」くらい付けて欲しいと感じましたね。

      ・「Windows アプリ UX デザイン ガイドライン | MSDN」
       https://msdn.microsoft.com/ja-jp/mt634411.aspx

      2017年9月18日月曜日

      VK3001H 2羽の鳥ちゃん[Simulacrum][WoT]

      Word of Tanks の Tier 5の重戦車。

      この戦車。砲の精度と貫通力がすごいんですが、HTなのに後方に居座るな的なマップ指示を入れられても気にしちゃいけない。時には、クレイジーな味方に撃たれてやられることもありますが気にしちゃいけません。同格HTと正面でガチでやれるのは、頭出しだけ。きちんとやれば勝率5割5分くらいはいけると思われる。

      FV304やらType 64やらTier 6や7の強戦車がいる環境で前にでるなんて無謀だし、戦車特性を生かせないので勝利に貢献できずに、即死が見えます。

      この戦車、正面から見ると鳥さんが2羽いるんです。


      かわいいでしょ?

      2017年9月16日土曜日

      Call of Duty 4 -- ”Un Jour Il Viendra Music Video” English Patient , Gabriel Yared [音楽]



      ヤレドは、カミーユ・クローデルの頃から好きなんですが、この曲もなかなか好き。

      サラブライトマンの歌声はすごいですね!

      CoD4を動画にしているところが笑えますね。

      2017年4月26日水曜日

      DOLORES CLAIBORNE - MAIN THEME (Danny Elfman) HQ [音楽]

      大学の時に映画館に見に行った映画。このテーマは映画の暗さとマッチして未だに傑作だと思う。個人的には、映画も原作よりかいい。"DOLORES CLAIBORNE - MAIN THEME (Danny Elfman) HQ" https://youtu.be/fERjO6Id97s



      2017年1月14日土曜日

      インフルエンザになったら、いつ会社や学校に行けるのか?[ヘルス]

      年明け2週間目からインフルエンザ(A型)に感染しました

      急に悪寒がして発熱が1日以上続きインフルエンザの症状がでました。

      ちなみに、インフルエンザに感染したのは、これで2回目です。感染経路は、2回とも、人が多い「100円ショップ」だと確信しています。乾燥している年末、年始の週末はマスクをした方が安全でしょう。

      発熱中に疑問に思ったことがあったので書いてみました。

      どのタイミングで病院に行くべきか?

      お医者さんにうかがったところ、高熱が出たらすぐに通院すべきだそうです。

      私は、忙しい病院にただの風邪や熱で行くのは迷惑だろうと考える年代です。インフルエンザの場合、飛散するウィルスの拡大を防ぐのが最優先というこで納得しました。

      いつ会社にいけるのか?


      次の条件を両方満たした場合に会社や学校に行けるそうです。
      1. 発症日+6日
      2. 解熱日+3日
      たとえば、1月9日に発症したら1月15日に行けます。ただし、37.5度以上の発熱が1月13日まで続いた場合、1月14日が解熱日になり、1月17日に行けます。6日間も37.5度以上で発熱するケースはレアだと思いますが・・・

      病院で頂いた資料には、次のように書かれていました

      出席停止期間:発症したあと5日を経過し、かつ解熱したあと2日を経過するまで(参考:学校保健安全法施行規制改正)
      発症日がカウントされないのに、解熱日がカウントされていて微妙な感んじがしますね。

      インフルエンザ停止期間 早見表
      インフルエンザ出席停止期間 早見表

      ウィルスのメカニズムに感動

      発熱の中いろんなことを考えましたが、ウィルスのメカニズムはミニマルでかつ効率的ですね。ウィルスは、ウィルスのDNAをホストの細胞に注入して、増殖させるというアプローチで増えます。自己増殖ができないんです。ウィルスはなんで存在するのか?ウィルスはどこから来たのか?そこにはロマンがあります。(笑)