polyshドキュメント / 実践ガイド
画面録画をステップバイステップガイドに変える。
同じ録画を、読みやすいハウツーにも活用しましょう。タスクを起点に言葉を見直し、各ステップの最後に読み手が確認できる結果を置きます。
ひとつの完結したタスクから始める。
良いガイドには、明確な出発点と目に見える結果があります。「チームメンバーを招待する」なら、読み手には完了すべきタスクがあります。「設定画面のツアー」では、使う理由のない画面の寄せ集めになってしまいます。
録画の前に、ガイドの対象者、必要な権限、完了時に表示されるべきものを書き出しておきましょう。ワークフローを録画する間も、その答えを手元に置いておきます。
シンプルな概要の例：ワークスペースの管理者がチームメンバーを招待したいとします。必要なのは招待の権限と、そのメンバーのメールアドレスです。招待が保留中と表示されれば、タスクは完了です。
ガイドを生成する前にナレーションを見直す。
話し言葉は、文章の手順とは違う方法でタスクを説明します。余談や言い直し、「それをクリック」のような指示語が入ることもあります。見直したスクリプトでは、操作項目の名前を明示し、操作を順番どおりに説明しましょう。
Polysh では、ガイドを生成する前に製品名やボタンのラベルを修正します。役立つ背景情報は残しつつ、読み手が実際に行う必要のある操作とは分けておきましょう。
操作、スクリーンショット、結果を確認する。
Polysh は、見直したナレーションを、グループ化されたステップ、前提条件、注記、期待される結果に変換します。生成されたガイドは、見直すための下書きとして扱いましょう。
- 操作：ステップは、画面に表示されている操作項目の名前を使って、何をすべきかを伝えていますか。
- スクリーンショット：その時点で読み手が必要とする画面を示していますか。
- 結果：読み手は操作がうまくいったかどうかを判断できますか。
スクリーンショットが間違っているステップは混乱を招きます。生成されたガイドに適切な画像がない場合は、キャプチャされた候補から選ぶか、適切な画像が用意できるまで省きましょう。共有する前に、機密情報が含まれていないか確認します。