Anonim

他の人に何かを行う方法を指示することになっているドキュメントの作成を担当している場合、今日のその方法は多かれ少なかれ、古いメソッドを窓から投げ出します。

1.大きな爆弾ヘッダー

この文のすぐ上にあるようなPCMechのヘッダーが巨大であることに気付くでしょう。 これは、ドキュメント内のどこを見ているのか、読んだり、知っているのが簡単だからです。

2.少ない言葉

進入禁止:

次のドキュメントでは、Fanny Whacker 2000の使用方法と操作方法について説明しています。

正しい方法:

Fanny Whacker 2000の使用方法に関する説明

ドキュメントを書くときは、このフレーズを常に覚えておいてください:できるだけ早くポイントに到達します。

3.無駄な参照をスキップする

参照が、あなたが記述しようとしているものの中核的な指示とは何の関係もない場合:

Fanny Whacker 2000のTurnip Twaddlerの詳細については、ドキュメントFUのサブセクションID10Tを参照してください。

…それをしないでください。

4.日付を記入します。 常に。

ドキュメントが作成された日付は、すべてのページのフッター領域にある必要があります。 電子文書の場合、日付は2回表示されます。 最初に一度、最後に一度。

これを「最終改訂(ここに日付を挿入)」と書くことができます。

5.警告は常に、返却されない地点の前に掲示する必要があります

誤って実行すると、ドキュメントに何かを損傷/破壊/抹消する可能性のあるものがある場合、この情報は指示の直後に配置し、同じページに表示し、アクセントを付けてください。

例:

ステップ5. Fanny Whacker 2000のクリーニング

FW2000のパドルは、研磨剤を含まない柔らかい布を使用して静かに清掃する必要があります。

警告: FW2000が爆発して不意に死亡するのを防ぐために、アンモニアを含まない溶剤のみを使用してください。

最後に、優れたドキュメントは、考えられるあらゆる可能性のあるすべてのことを超記述的にすることではありません。 ドキュメントを読んで自問してください。適切に指示されていますか? 答えが「はい」である場合、次の質問は、 すぐ に指示されますか? はいの場合、ドキュメントは良好です。

より良い指導文書を書くための5つのヒント