アドビドキュメントの記述ガイドライン

これらのガイドラインは、新しいドキュメントを作成するか、既存のドキュメントを更新するかに関係なく適用されます。

次の点に留意してください。

  • 誤字脱字や文法的な間違いがないようにします。
  • 親しみやすいトーンにします。
  • シンプルな文にします。その方がわかりやすく、他言語への翻訳も容易になります。

スタイルガイドライン

ドキュメントを記述する際は、次の点に留意してください。

  • 簡潔に書く:冗長な表現を避けます。文は短く簡潔にします。記事の焦点を絞ります。メモの数は最小限にします。
  • 対象と目的を絞る:書き始める前に、読み手は誰で、何のタスクを実行しようとしているかを明確にします。読み手がそのタスクを実行するときに役立つような記事を書きます。
  • 例を示す:概念を説明する例を示します。
  • コンテンツを整理する:いくつかのセクションを設け、手順をいくつかの扱いやすいグループに分けるようにします。画面を示した方がわかりやすいときは、スクリーンショットを追加します。

このページ