テクニカルライティングドキュメントの概要を説明する方法。よく書かれた文書は偶然には作成されません。レポート、マニュアル、またはその他の技術文書で扱われる資料は、計画され、整理されてから書かれます。文書のアウトライン化の段階は重要なステップであり、アウトラインが作成されていないと情報が論理的に表示されない可能性があります。概説することで、作者は含まれるべきであるべきではないはずの情報について考える機会を与えられます。
あなたのアイデアをブレインストーミングします。技術文書に含めるべきだと思うアウトラインのアイデアをすべて書き留めます。情報の順序を気にする必要はありません。すべての情報がブレーンストーミングプロセスに含まれていることが重要です。
技術文書の目的を決定します。誰がその文書を読むのか、なぜそれが読まれるのか、そしてどのように使われるのかなど、自分自身に質問してください。
どの種類のアウトラインを作成するかを決定します。歴史的、年代順、一般的なもの、小さいものから大きいもの、単純なものから複雑なもの、またはコンテンツに適したその他の形式。観客とあなたが提示したい情報について考えてください。情報がどのように配置されているかが、提示される情報の種類と、技術文書を読むことになる読者にとって最も理にかなっていることを確認してください。
適切な順序で情報を並べます。概要では、情報を論理的なセクションとレベルにグループ化します。メイントピックとサブトピック、およびサブサブトピックを作成できます。
情報を検討して主題が適切かつ論理的に編成されていることを確認して、概要を完成させます。重要な事実を見逃さないように注意してください。技術文書に関連しない情報を削除します。
