Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

手順 / タスク / 手続き

最終更新 Markdown で表示Agent セットアップ

定義

実行する手順と、その順序を示す、行動志向のプロセスです。

使用箇所

How toTutorial

構成

1 手順の手続き: 手続きが 1 手順だけのときは、その手順を導入文に含めます。

番号付き手続きのサブステップ: 番号付きの手続きでは、サブステップは小文字のアルファベット、その下は小文字のローマ数字にします。

  • 手順にサブステップがあるときは、その手順を導入文として扱います。適切な位置で、手順の末尾にコロンまたはピリオドを付けます。

複数アクションの手続き: 1 つのアクションを 1 手順にします。ただし、小さなアクションは 1 手順にまとめて構いません。

同じタスクに複数の手続きがある場合: タスクの完了方法が複数あるときは、すべてのユーザーが利用できる手続きを 1 つ選んでドキュメント化します。すべての手続きを書く必要がある場合は、見出し、ページ、またはタブで分け、読者に同じタスクの別の方法だとわかるようにします。

どの手続きをドキュメント化するかは、次の指針で選べます。

  • キーボードだけで全手順を実行できる手続きを選びます。
  • いちばん短い手続きを選びます。
  • 読者の大多数が知っているプログラミング言語を使う手続きを選びます。

繰り返しの手続き: 手順は簡潔にし、繰り返しや、太字の UI 要素の多用で読者を圧倒しないようにします。

箇条書きと番号付きリスト

事後条件(post requisites): 現時点では使いません。事後条件のセクションが必要だと思う場合は、その作業を手続きの最後の手順にするか、Next steps に移すことを検討します。

手続きを書くときの指針

最初の手順としてダッシュボードへのログインが必要な場合は、ログインと移動を最初の手順にまとめます。また、"log into" ではなく "log in to"(3 語)と書きます。

手順のあとに Enter を押す必要がある場合は、その指示を手順の一部に含めます。

設定のオン/オフが必要な場合は、"enable/disable" ではなく "turn <FEATURE_NAME> on/off" を使います。名前が長い機能では "turn on/off <FEATURE_NAME>" でも構いません。

アクションの目的を先に述べてから、アクションを書きます。

読者がたどる順序で書きます。アクションの場所を先に述べてから、アクションを書きます。一連の手続きに複数の見出しがある場合は、場所が前の手続きと同じでも、各手続きの最初の手順でアクションの場所を再度述べます。

"please" は使いません。

補足

完全な文を使います。

並列構造(parallel structure)を使います。

二人称の命令形を使います。どの動詞(click、select、choose など)をいつ使うかは、スタイルガイドを参照します。

任意の手順では、手順の先頭に (Optional) と書きます。

  • 例: (Optional) Type an arbitrary string, to be delivered to the target address with each notification delivered over this channel.

キーボードショートカットは含めません。

above、below、right-hand side など、位置で読者を案内する表現は使いません。この種の表現はアクセシビリティにもローカライズにも向きません。UI 要素が見つけにくい場合は、スクリーンショットを付けます。

「The <screen/page/card> displays.」のような文は、必要なときだけ使います。

役に立ちましたか?