手順はレシピ、つまり誰が何をするべきか、いつ行うべきか、どのように行うべきか、そして何をするべきかを明確に述べた一連の指示のようなものです。完了する必要がある順序で各ステップをリストします。職務内容、部署、機能、または情報がマニュアルのユーザにとって最も利用しやすいものになっている順序で整理されたマニュアル内の複数の手順をコンパイルします。ポリシーと手順を混同しないでください。方針は、規則または意見書です。手続きは、人々が政策を実行するために従うものです。
あなたが必要とするアイテム
-
リソース資料となる可能性のある既存の資料
-
手順の実行方法を知っている主題の専門家
どの手順を文書化するかを決定します。マニュアルの内容を選択する2つの方法は、潜在的なマニュアルユーザを調査して、明確にする必要のあるタスクや詳細な情報を見つけることです。あるいは、明確に定義された手順で解決できる運用上の問題のリストを作成します。
情報を集める最初から手順を作成しているのでない限り、すでにそのタスクを実行している人が最善のリソースです。その人がそのタスクを実行してメモを取るのを見るか、そのタスクに関連するすべてのステップ、および経験から学んだヒントや警告を書き留めてください。
マニュアルのレイアウトを決めます。 2列形式であるため、手順が明確で読みやすくなります。各ページに手順の名前を付け、手順の実行頻度やヒントや警告など、手順に含まれない事実のリストまたは段落をタイトルの下に置きます。その後の手順は、2列の表に従ってください。
下書きを書きます。左側の列に、手順の責任者をリストします。右側の列に、人が実行するステップを順番にリストします。この手順に複数の人が関与する場合は、誰もがプロセスのどこに該当するのか、また何をする必要があるのかを明確に確認できるはずです。
手順をテストしてください。ドラフトからそれらに従うための手順に慣れていない誰かを取得します。経験の浅い人を使用することは重要です。その人は、習慣的な近道を取ったり、他の読者が理解できないような不明確な点に目を光らせたりすることはありません。
ドラフトを修正してください。マニュアルを読んだ人が手順を実行できるようになるまで、手順を明確にし、追加し、削除し、並べ替えます。
マニュアルを公開する読者がすぐに手順を見つけることができるように目次を含めます。珍しい、またはあなたの業界に固有の用語を定義した用語集を追加してください。
ヒント
-
文章を活気づけるために優雅な単語のバリエーションを使用しないでください。 「ウィジェット」は毎回のウィジェットであり、「アイテム」や「デバイス」ではありません。物事を一貫して記述することは反復的かもしれませんが、それは読者のための明快さを改善します。
