创作最佳实践

上次更新: 2023-11-01
  • 创建对象:
  • Developer
    User
    Admin
    Leader

概述

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

一般指导

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

书写样式

重要

读取 Adobe文档编写指南 在开始创作目标文档页面之前。

  • 把你的句子短一点,尽快切入正题。 如果您的句子超过20个单词或使用多个逗号,请考虑将其拆分为单独的句子。 长度超过20个词的句子对读者来说尤其具有挑战性。
  • 别太客气了。 避免在技术文档中使用“请”或“请……”。

链接

按照提供的文档模板操作,不要编辑模板中的现有链接。 包含新链接时,请阅读 在文档中使用链接 在投稿人指南中。

品牌指南

  • AEP不是一个经批准的面向公众的术语。 请先使用Adobe Experience Platform,然后再使用Experience Platform和平台。
    • 不使用:将数据从AEP导出到目标之前,请确保已阅读并完成这些先决条件。
    • 使用:将数据从Adobe Experience Platform导出到目标之前,请确保已阅读并完成这些先决条件。

图像和屏幕快照

  • 有关的信息 如何链接到图像,请参阅投稿人指南。
  • 在使用屏幕快照时,请确保屏幕快照捕获了整个Platform UI屏幕。
  • 在标记图像以突出显示页面上的某个控件或标签时,请尝试遵循Experience Platform文档团队使用的标记样式。 请注意如何在中高亮显示基于配置文件的 此屏幕快照.
  • 请使用 png 设置图像格式。
  • 请勿使用编号屏幕截图作为文件名。 图像文件名应为描述性的。
    • 不使用1.png2.png3.png
    • 使用: yourdestination-authentication-details.png, yourdestination-destination-details.png
  • 请为您添加到文档的任何图像使用替换文本,并在替换文本中使用正确的语法。
    • 不使用:目标连接详细信息
    • 使用:Platform UI的图像,显示填写的目标连接详细信息。

过程

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

在此页面上