文档Experience Platform目标指南

创作最佳实践

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • undefined
  • undefined

概述 overview

本页介绍了在创作目标文档页面时应遵循的规则，以确保其符合Adobe Experience Platform文档质量标准。

一般指导 general-guidance

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

书写样式

IMPORTANT
在开始创作目标文档页面之前，请阅读Adobe文档的编写指南。
  • 把你的句子短一点，尽快切入正题。 如果您的句子超过20个单词或使用多个逗号，请考虑将其拆分为单独的句子。 长度超过20个词的句子对读者来说尤其具有挑战性。
  • 别太客气了。 避免在技术文档中使用“请”或“请……”。

链接 linking

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

品牌指南 branding

  • AEP不是一个经批准的面向公众的术语。 请先使用Adobe Experience Platform，然后再使用Experience Platform和平台。

    • 请勿使用：在将数据从AEP导出到YourDestination之前，请确保已阅读并完成这些先决条件。
    • 使用：在将数据从Adobe Experience Platform导出到YourDestination之前，请确保已阅读并完成这些先决条件。

图像和屏幕快照 images-and-screenshots

  • 有关如何链接到图像的信息，请参阅参与者指南。

  • 在使用屏幕快照时，请确保屏幕快照捕获了整个Platform UI屏幕。

  • 在标记图像以突出显示页面上的某个控件或标签时，请尝试遵循Experience Platform文档团队使用的标记样式。 请注意，在此屏幕快照中如何高亮显示基于配置文件的。

  • 请使用png格式图像。

  • 请勿使用编号屏幕截图作为文件名。 图像文件名应为描述性的。

    • 不使用： 1.png，2.png，3.png
    • 使用： yourdestination-authentication-details.png，yourdestination-destination-details.png

  • 请为您添加到文档的任何图像使用替换文本，并在替换文本中使用正确的语法。

    • 不使用：目标连接详细信息
    • 使用： Platform UI的图像，显示填写的目标连接详细信息。

进程 process

  • 文档模板很少根据合作伙伴反馈进行更新。 开始为目标创作文档之前，请确保已下载最新版本的模板。
  • 创作文档并从分支​ 中除主分支 ​之外的其他分支创建文档拉取请求(PR)。 在GitHub接口或您的本地环境中进行创作时，请参阅提交目标以供审核部分。
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6