ステップ/タスク/手順
実行指向のプロセスで、取るべきステップとその順序を概説します。
単一ステップ手順: 手順が1つのステップのみで構成される場合、そのステップを導入文に追加します。
番号付き手順のサブステップ: 番号付き手順では、サブステップは小文字のアルファベットで、サブサブステップは小文字のローマ数字を使用します。
- ステップにサブステップがある場合、そのステップを導入文のように扱います。適切な場合は、ステップの最後にコロンまたはピリオドを付けます。
複数アクション手順: アクションごとに1つのステップを使用します。ただし、小さなアクションを1つのステップにまとめることができます。
同じタスクの複数手順: タスクを完了する方法が複数ある場合、すべてのユーザーがアクセスできる手順を1つ選んで文書化します。すべての手順を文書化する必要がある場合は、別々の見出しやページ、タブを使用して手順を分け、読者に同じタスクを完了するための代替方法であることを明確にします。
以下のガイドラインは、文書化する手順を選ぶ際に役立ちます：
- 読者がキーボードのみですべてのステップを実行できる手順を選びます。
- 最も短い手順を選びます。
- 大多数の聴衆が慣れているプログラミング言語を使用する手順を選びます。
繰り返し手順: 簡潔な手順を使用して、繰り返しを避け、ユーザーを多くの太字のUI要素で圧倒しないようにします。
事後要件: 現在は使用されていません。事後要件セクションが必要だと感じた場合は、手順の最後のステップとしてタスクを追加するか、内容を次のステップに移動することを検討してください。
ユーザーが最初のステップとしてダッシュボードにログインする必要がある場合、ログインとナビゲーションを最初のステップに統合します。また、「log in to」（3語）と書き、「log into」とは書かないでください。
ユーザーがステップの後にEnterを押す必要がある場合、その指示をステップの一部として含めます。
ユーザーが設定をオンまたはオフにする必要がある場合は、enableを使用します。
アクションの目的を述べた後にアクションを述べます。
読者が従う必要がある順序で書きます。アクションの場所を述べた後にアクションを述べます。手順のセットに関連する複数の見出しがある場合、各手順の最初のステップでアクションの場所を再度述べます。たとえその場所が前の手順と同じであってもです。
「please」を使用しないでください。
完全な文を使用します。
平行構造を使用します。
第二人称命令形で書きます。特定の動詞（クリック、選択、選ぶなど）を使用する際のガイダンスについては、スタイルガイドを参照してください。
オプションのステップの場合、ステップの最初の単語として(Optional)と入力します。
- 例: (Optional) 任意の文字列を入力し、このチャネルを介して配信される各通知に対してターゲットアドレスに届けます。
キーボードショートカットを含めないでください。
上、下、右側など、読者を方向付けるための言語を使用しないでください。この種の言語は、アクセシビリティやローカリゼーションにうまく機能しません。UI要素が見つけにくい場合は、スクリーンショットを提供してください。
「<screen/page/card>が表示されます。」のような文を賢く使用します。