エージェント向け Polysh を早期アクセスで提供中。コーディングエージェントがデモを録画し、Polysh が仕上げます。 ウェイティングリストに登録 →

手順の複雑さチェッカー

詰め込みすぎ、あいまい、動作主が不明なステップを見つけられます。

このツールは英語のテキストを分析します。

ブラウザツールを読み込んでいます…

手順の複雑さチェッカーでできること

よい手順は、1 つのステップで 1 つのことをします。手順を貼り付けると、各ステップについて、読み手が手を止めて読み返す原因になる問題をチェックします。1 行に select と click のような 2 つ以上の操作がある、if や unless で始まる条件がある、単語数が上限を超えている、simply、just、as needed のようなあいまいな語がある、受動態である、といった問題です。

テキストに Procedure または Steps の見出しがある場合は、その下のステップだけをチェックします。ない場合は、すべてのステップまたは文をチェックします。評価は、指摘されたステップがなければ「低」、3 分の 1 未満なら「中」、それより多ければ「高」です。各指摘には、「別々のステップに分けてください」や「判断のステップを分けることを検討してください」のように、何をすべきかが書かれています。

例

入力

## Procedure
1. Open Users.
2. Select the account and click Reset MFA.
3. If the user is an admin, notify security.
4. Simply close the ticket.

結果

Complexity: High (3 of 4 steps need attention)
1. Clear
2. 2 actions (select, click), split into separate steps
3. Condition (if), consider a separate decision step
4. Vague or jargon words: simply

手順の複雑さチェッカーの使い方

  1. 手順を貼り付けます。ステップの上に Procedure の見出しがあるのが理想です。
  2. 「指摘する文の長さ」を、1 ステップの単語数の上限に設定します。
  3. 「問題なし」になっていないステップを、指摘が 2 つ以上あるものから順に直します。

知っておきたいこと

  • 操作は、よく使われる UI の動詞の固定リストから判断します。pick や launch のようなあまり一般的でない動詞を組み合わせたステップは、複数の操作として指摘されないことがあります。
  • あいまいな語にも問題のない使い方があります。just under 2 MB の just や some users の some も指摘されるので、指摘ごとに直すべきかを判断してください。
  • 条件は、それが適切な場合でも指摘されます。ステップの冒頭にある短い if は、別の判断ステップにするよりわかりやすいことがよくあります。

手順の複雑さチェッカーについてよくある質問

わかりやすいステップバイステップの手順を書くには?

各ステップを動詞で始め、1 ステップに 1 つの操作とし、ボタンやフィールドの名前を正確に書き、その後に読み手に何が見えるはずかを書きます。If you see an error のように条件を先に書き、説明はステップから注記に移してください。

各ステップの操作を 1 つにすべきなのはなぜですか?

人は文書と画面を行き来しながら手順をたどります。1 ステップに 1 つの操作なら、どこまで進んだかを見つけ直せますし、何かが失敗したときに、どのステップで問題が起きたかを正確に伝えられます。1 行に 2 つの操作があることは、ステップが飛ばされる最もよくある原因です。

simply や just のような語を避けるべきなのはなぜですか?

こうした語はステップが簡単だと読み手に伝えるため、つまずいた人に自分のせいだと感じさせてしまい、しかも指示には何も加えません。取り除けば、ステップは短く中立的になります。as needed のような語はさらに問題です。読み手が下すべき判断を隠してしまうからです。