スクリーンショット入りの手順書を最新に保つ方法

画像、ラベル、説明が現在の作業と一致している間だけ、スクリーンショット入りの手順書は役に立ちます。現実的な保守手順では、製品変更と影響を受けるガイドを結び付け、必要な手順だけを差し替え、更新後の流れをテストし、誰が確認したかを記録します。リリースのたびにすべてのガイドを作り直す必要はありません。

要点： ガイドごとに確認済みの製品バージョンと担当者を記録します。変更された画面と作業から影響範囲を確認し、該当する手順を差し替えた後、最初から最後までガイドを 1 回実行してから確認日を更新します。

担当者と確認済みバージョンを決める

担当者は、すべての更新を書く人ではなく、内容の正確さに責任を持つ人です。現在の手順を確認し、変更を承認できる役割を記録します。

各ビジュアルガイドには、次の項目を保存します。

ガイド担当者：
確認した製品または手順のバージョン：
最終確認日：
次回の定期確認日：
使用する画面または機能：
使用する UI ラベル：
元画像の保存場所：

このメタデータがあれば、リリースノートから影響を受けそうな手順書を絞り込めます。公開済みの全ページを一つずつ探す必要はありません。

製品変更を確認のきっかけにする

決まった日を待つより、変更が起きたときに確認するほうが正確です。ガイドで使うラベル、画面配置、移動経路、権限、プランの利用条件、書き出し、エラー状態、既定値がリリースで変わったら、見直しを始めます。

明確な製品変更をきっかけにしにくいページには、定期確認も有効です。閲覧数の多い初期設定、セキュリティ、請求、取り消しにくい操作、頻繁に変わる UI は、確認間隔を短くします。

変更と影響を受ける手順を結び付ける

変更の影響を確認するときは、どの説明、スクリーンショット、確認点、よくある質問、リンクが新しい動作に依存しているかを特定します。画像だけを差し替えればよいとは限りません。

たとえば、Export ボタンの位置が変わると、スクリーンショットだけでなく、場所を説明する文章も影響を受けます。プランで使える形式が変わると、主要な手順、比較表、よくある質問、メタデータの説明、料金ページへの内部リンクまで変わる可能性があります。

次の項目で変更を確認します。

• どのラベルが変わったか
• どの操作部品が移動した、または状態が変わったか
• 操作の順序が変わったか
• 開始条件や権限が変わったか
• 想定する結果が変わったか
• プランや提供条件が変わったか
• どのガイド、キャプション、代替テキスト、よくある質問、リンクがその内容に触れているか

影響を受ける手順だけを差し替える

必要な箇所だけを差し替えれば、確認作業を減らし、変わっていないページには手を加えずに済みます。同じ安全な開始状態からガイドを再現し、変更された手順と、既存の流れにつながるだけの前後関係を撮影します。

新しい操作によって後の手順の順序や表示状態も変わる場合は、複数ページを差し替えます。読者が互換性のない UI バージョンの間を行き来することになるなら、古い手順に新しいスクリーンショットを 1 枚だけ挿入してはいけません。

Action Capture では、影響を受ける操作を順番どおりに再撮影できます。新しい流れと公開中のガイドを比べ、変更箇所の差し替えに必要なページだけを残します。

文章、注釈、プライバシーを再確認する

編集時には、正確なラベル、操作の説明、矢印、クリック位置、切り抜き、Action Focus、ぼかし、想定される確認点を更新します。最初は似た画像に見えても、古い注釈が何もない場所を指していることがあります。

プライバシーも改めて確認します。再撮影したアカウント、メニュー、通知、サンプルプロジェクトに、以前の版にはなかった情報が写り込む場合があります。

ガイド全体をテストする

回帰テストは最初の手順から始め、公開中の開始条件を使います。差し替えたページだけを確認すると、新しい前提条件や、その手順に入るまでの変化を見落とす可能性があります。

読者が明記された同じ結果に到達でき、すべてのラベルが一致し、ページ順が正しく、個人情報が保護され、すべての内部リンクが表示できるページを指していれば、更新版を公開できます。

この一連の確認が終わってから、確認済みバージョンと確認日を更新します。

履歴が読者に必要な場合だけ古い版を保管する

利用者が古いリリースを使い続けている場合、サポートが過去の動作を再現する場合、規制上の記録が必要な場合は、以前の版にも意味があります。対象バージョンを明記し、それが標準の手順でない場合は、現在の検索やナビゲーションに古いガイドを出さないようにします。

一般公開するヘルプ記事の多くは、ソース管理や文書履歴に以前の版を残し、公開 URL では確認済みの現在の手順だけを示せば十分です。すでに対応していない製品バージョンだけが異なるページを、検索可能な状態で複数公開するのは避けます。

この記録で保守状況を管理する

更新ごとに、次の簡潔な記録を残します。

ガイド：
担当者：
変更元：
影響を受ける手順：
更新した文章：
更新した画像：
プライバシー確認完了：
最初から最後までのテスト完了：
確認済みバージョン：
確認者：
確認日：
次のきっかけまたは日付：

公開中のガイド、その画像、メタデータ、担当者の記録が、現在の作業について一致すれば、保守の一巡は完了です。影響を受けるページの再撮影にはクリックから Mac 用の手順ガイドを作る方法を参照し、差し替え用の一連の画像をまとめて確認するには Action Capture を使えます。