オーサリングのベストプラクティス

概要

このページでは、次の場合に従う必要があるルールについて説明します 宛先ドキュメントのオーサリング ページを開き、Adobe Experience Platformのドキュメント品質標準を満たしていることを確認します。

一般的なガイダンス

  • を テンプレート 宛先のドキュメントについては、『Adobe投稿者ガイド』を参照してください。 リンク, テーブル、 サポートされる markdown 構文, 記述指針など。
  • 製品ドキュメントには、観測と推定を含めないでください。
  • Experience Platformドキュメントでは、Adobeライターは 太字書式 次のように、ユーザーインターフェイスコントロールを参照するには、次の手順を実行します。
    • に移動します。 接続 > 宛先​をクリックし、 カタログ タブをクリックします。 ユーザーインターフェイスコントロールが 宛先のチュートリアル.

書き方

重要

読み取り Adobe文書の記述ガイダンス 宛先ドキュメントページのオーサリングを開始する前に、

  • 文章を短くして、早く要点にたどり着きましょう。 文の長さが 20 語を超える場合や、複数のコンマを使用する場合は、文を別々の文に分割することを検討してください。 20 語を超える文は、読者にとって特に難しい文章です。
  • 過度に礼儀正しくするな。 「please」や「dyndly do …」を使用しないでください。 （技術ドキュメント）。

リンク

提供されたドキュメントテンプレートに従い、テンプレート内の既存のリンクを編集しないでください。 新しいリンクを含める場合は、 ドキュメント内でのリンクの使用 （コントリビューターガイド）。

ブランディングのガイドライン

  • AEP は、公開用語として承認されていません。 最初の使用時にAdobe Experience Platformを使用し、次にExperience Platformを使用し、次に Platform を使用してください。
    • 次を使用しない:AEP から宛先にデータを書き出す前に、次の前提条件を読み、満たしていることを確認してください。
    • 用途:Adobe Experience Platformから宛先にデータを書き出す前に、次の前提条件を読み、満たしていることを確認してください。

画像とスクリーンショット

  • 詳しくは、 画像へのリンク方法（コントリビューターガイドを参照）。
  • スクリーンショットを使用する場合は、スクリーンショットに Platform UI の画面全体が取り込まれていることを確認してください。
  • ページ上の特定のコントロールまたはラベルをハイライト表示するために画像をマークアップする場合は、Experience Platformドキュメントチームが使用するマークアップスタイルに従ってください。 プロファイルベースが このスクリーンショット.
  • 以下を使用してください： png 画像の形式設定
  • 番号付きスクリーンショットはファイル名として使用しないでください。 画像ファイル名は説明的である必要があります。
    • 次を使用しない: 1.png, 2.png, 3.png
    • 使用方法: yourdestination-authentication-details.png, yourdestination-destination-details.png
  • ドキュメントに追加する画像に代替テキストを使用し、代替テキストに適切な文法を使用してください。
    • 次を使用しない:宛先接続の詳細
    • 用途:宛先接続の詳細を示す、Platform UI の画像が入力されました。

プロセス

このページ