创作最佳实践

概述

本页介绍了在 创作目标文档 页面，以确保其符合Adobe Experience Platform文档质量标准。

一般指导

• 在 模板 有关目标文档，请参阅Adobe参与者指南，以了解有关 链接, 表, 支持的markdown语法, 编写指南，等等。
• 在产品文档中不要包含观察和估计。
• 在Experience Platform文档中，Adobe作者使用 粗体格式 要引用用户界面控件，请如下所示：
  • 转到 连接 > 目标，然后选择 目录 选项卡。 查看 目标教程.

书写样式

• 你的句子要短一些，要快一点。 如果您的句子超过20个词或使用多个逗号，请考虑将其分成不同的句子。 长度超过20个词的句子对读者来说尤其具有挑战性。
• 别太客气。 请避免使用“请”或“请……” 中。

链接

按照提供的文档模板操作，但不要编辑模板中的现有链接。 包含新链接时，请阅读 在文档中使用链接 参与者指南中的。

品牌策略准则

• AEP不是已批准的面向公众的术语。 请先使用Adobe Experience Platform，然后Experience Platform，再使用Platform。
  • 不使用:在将数据从AEP导出到YourDestination之前，请确保已阅读并完成这些先决条件。
  • 使用:在将数据从Adobe Experience Platform导出到YourDestination之前，请确保已阅读并完成这些先决条件。

图像和屏幕截图

• 有关 如何链接到图像，请参阅参与者指南。
• 使用屏幕截图时，请确保您的屏幕截图可捕获整个Platform UI屏幕。
• 在标记图像以突出显示页面上的特定控件或标签时，请尝试遵循Experience Platform文档团队使用的标记样式。 请注意基于用户档案的内容如何在 此屏幕截图.
• 请使用 png 设置图像格式。
• 请勿使用编号的屏幕截图作为文件名。 图像文件名应具有描述性。
  • 不使用: 1.png, 2.png, 3.png
  • 使用: yourdestination-authentication-details.png, yourdestination-destination-details.png
• 请对您添加到文档中的任何图像使用替换文本，并在替换文本中使用正确的语法。
  • 不使用:目标连接详细信息
  • 使用:平台UI的图像，显示已填充的目标连接详细信息。

过程

• 的 文档模板 会根据合作伙伴的反馈，偶尔更新。 在开始为目标位置创作文档之前，请确保已下载 模板的最新版本.
• 创作文档并从分支的分支创建文档拉取请求(PR) 除主分支之外. 在中创作时，请参阅提交目标以供审阅一节 GitHub界面 或 您的本地环境.

Business.Adobe.com 资源