Technical Documentation Copy and Paste Kit

説明

いいえ、このキットは、次回のユーザー マニュアルや次回のオンライン ヘルプ システムを作成するものではありません。ただし、このキットを使用すると、少ない労力で技術文書を作成でき、ユーザー フレンドリーで高品質の文書を作成できます。

このキットは、テキスト エディター、ヘルプ オーサリング ツール、またはコンテンツ管理システムでは提供されないもの、つまり、高品質のユーザー アシスタンスを作成するためのノウハウとガイダンスを提供します。

ただし、テクニカル ライティングに関する多くの教科書とは異なり、このキットでは理論的な説明が長くはありません。簡単に覚えて自分の仕事に適応できる実用的な推奨事項と例を示します。

キットの内容:

* ドキュメントのビジュアル デザイン (レイアウト)

* ドキュメントの構造

* すべてのユーザーが理解できるわかりやすい指示の書き方

デザインの推奨事項を実装するのにデザイナーである必要はありません。また、記述規則を理解するのに言語学者である必要もありません。すべての推奨事項には、キャッチーな例が付属しています。

キットは平易な英語で書かれているので、第二言語として英語を話す人でも簡単に理解できます。ほぼすべてのルールが共通なので、英語以外の言語で書く場合にもキットを使用できます。

キットのプラス エディションでは、あなたとあなたのチームは、独自の会社固有の規則と規則を追加できます。プロフェッショナルでありながらカスタムのインタラクティブなライティング スタイル ガイドを入手することは、かつてないほど容易になりました。誰がルールを編集できるかを自由に制御できます: 自分だけ、選択したチーム メンバーのみ、または全員。