Microsoftが公開している英文スタイルガイドから項目を取り上げて紹介します。記事の英語難易度は「中〜上級」です。
今回は、マニュアルなどの手順の書き方です。
- GitHubページ:https://github.com/MicrosoftDocs/microsoft-style-guide/blob/main/styleguide/procedures-instructions/writing-step-by-step-instructions.md(2022-10-13閲覧。ウェブページ表示)
- 本記事内のサンプル英文も上記より取得
ステップが複数ある場合
手順内にステップが複数ある場合、番号リストを使います。
この番号リストでの書き方です。
- 手順の書式は他と統一する。統一されていると読者は一目で見つけやすい。
- 何ができるのかを読者がすぐ把握可能な「見出し」を付ける。見出しの形式も全体で統一する。
- 例:To create a group of tiles
- 各ステップに別々の番号を振る。ただしUI内の同じ場所で実行する短いステップであれば、まとめてよい。
- 通常、操作完了となるステップを入れる。「OK」や「Apply」ボタンを押すステップなど。
- 完全な文とする。
- 命令形を使う。日本語では「〜してください」と丁寧に書くことがあるが、pleaseなどは不要。
- 文の構成は統一する。例えば、まず操作の場所(下記例の下線部分)を明示し、続いて動詞の命令形で書く(下記例のボールド部分)。
- 例:1. On the Start screen, select the tiles you want to group together.
- 各ステップの最初の語は大文字にする。
- 各ステップの最後はピリオドで終える。
- ただし、読者に何かを入力してもらうステップの場合、ピリオドまで入力してしまいそうならピリオドは書かない。できれば改行してから入力内容を書く。
- ステップは7つまでにする。可能ならもっと少ないほうがよい。全ステップが1画面に入るくらいの長さにする。
ステップが1つの場合
ステップが1つだけの手順でも、複数の場合と同じ書式を使います。
ただし、番号リストではなく、中黒リストにします。Microsoftの例を挙げます。
To move a group of tiles ・ On the Start screen, zoom out and drag the group where you want.
ステップを書く際のコツ
操作内容を書く前に、操作の場所を明示するようにします。
前述の例を再掲しますが、「On the Start screen, select the tiles you want to group together.」の下線部分です。
- ただし操作指示がUIの同じ場所に表示される場合、普通は場所について詳しく書く必要はない。
- ユーザーが正しい場所で操作しているのを再確認する必要があれば、最初に場所を書く。
- 例:On the Design tab, select Header Row.
- ユーザーが混同してしまう恐れがあれば、最初に場所を書く。
- 例:On the ribbon, go to the Design tab.
山かっこを使った簡潔な指示
半角の閉じ山かっこ(>)を使って、連続の指示を簡略化できます。山かっこの前後にはスペースを入れ、ボールドにはしません。
Microsoftの例を挙げます。
- Select Accounts > Other accounts > Add an account.
ただし音声読み上げソフトでは山かっこを読み上げないため、この方法で混乱が生じないかを専門家に相談した方がよいとしています。
なお、Googleのスタイルガイドにも手順の書き方が紹介されており、こちらの記事にまとめています。
(ライセンス表示: 本ページの一部内容は、Creative Commons 4.0 Attribution Licenseに基づきMicrosoft社の著作物を改変して利用しています。)
[筆者紹介]
西野 竜太郎
Ryutaro Nishino
翻訳者/情報技術者
著書に『アプリケーションをつくる英語』(第4回ブクログ大賞)、『ITエンジニアのための英語ライティング』、『ITエンジニアのための英語リーディング』、『ソフトウェア・グローバリゼーション入門』など。
産業技術大学院大学修了(情報システム学修士)、東京工業大学大学院博士課程単位取得(専門は言語学)。TOEIC 985点。
東京通信大学外部講師。
リンク:ウェブサイト
