Adobe 文档参与者指南

本指南介绍如何贡献Adobe企业Experience League帮助。

什么是协作文档?

Adobe Experience Cloud和其他Adobe企业产品的技术文档和支持内容基于使用GitHub、Markdown和Adobe Experience Cloud解决方案的开源原则。

此开源模型可提高内容质量并改善客户、文档团队和产品团队之间的沟通。 如今,您在每个页面上都可以评价内容实用性、记录问题,甚至可以将有关的内容建议作为 Git 拉取请求 (PR) 进行投稿。Adobe 文档团队每天都在检查投送的稿件和有关问题,并且会根据需要进行更新和调整。

使用协作文档

作为本材料的用户 - 无论您是员工、合作伙伴、客户还是潜在客户 - 您都可以选择采取以下几种简便的方式,为这类文档投稿:

  • 评价页面的实用性
  • 针对特定页面记录问题
  • 提交对整个文章的快速编辑以创作,以及使用资产和代码示例完成

关于如何与这类文档材料小组进行互动以及如何投稿,本指南概述了您需要了解的所有相关内容。

对现有文档进行快速编辑

快速编辑非常适合修复文档中的小错误和遗漏。如果文章显示如下所示的编辑按钮,您可以自己进行快速修复。编辑文档时,您可以提交拉取请求 (PR) 以向我们提交修复/建议,之后,我们可以检查、批准和发布建议。

  1. 签署参与者许可协议 (CLA)(如果接受)。

    您只需提交一次 Adobe CLA 即可。

  2. 单击 Edit this page 在右列中,转到GitHub上的markdown源文件。

    编辑此页面图标

  3. 单击铅笔图标可编辑相关文章。

    注意

    如果铅笔图标呈灰显状态,则表明您需要登录您的 GitHub 帐户,或创建一个新帐户。

    铅笔图标的位置

  4. 在 Web 编辑器中进行更改。

    您可以单击 Preview changes(预览更改)选项卡以检查所做更改的格式。

  5. 进行更改后,滚动到页面底部。

    输入PR的标题和描述,然后单击 Propose file change 如下图所示:

    提出更改建议

    注意

    如果您收到有关签署“参与者许可协议”(CLA) 的验证错误消息,请单击 Details(详细信息),以打开相关的许可协议。签署协议(如果接受)。接下来,关闭并打开拉取请求,然后继续操作。

以上就是所有步骤。文档团队成员将审核并合并您的拉取请求。谢谢!

记录问题

让我们了解某段内容问题的另一种简单方法是使用 Log an Issue.

  1. 如果您看到某段内容有问题,请单击右列的 Log an Issue 图标。

    注意

    要记录问题,您必须登录到您的GitHub帐户,或创建帐户。

    单击此链接,可使用“Github问题”界面快速记录Experience League。

    描述字段中会自动填充存在问题的页面的URL。

  2. 填写标题,简要描述问题,然后单击 Submit new issue(提交新问题)。

提交问题时,会通知负责此页面的内容团队,他们可以解决您的问题。 更新内容后,我们会通过“Github 问题”界面通知您,并且会在内容更新或关闭时通过电子邮件通知您。

了解 GitHub 权限

GitHub 编辑 UI 会根据您的存储库权限自行调整。对于不具有目标存储库写入权限的参与者,前面的图像是准确的。GitHub 会自动在您的帐户中创建目标存储库分支。如果您具有目标存储库的写入权限,GitHub 会在目标存储库中创建一个新分支。

Adobe 会对所有更改使用拉取请求,甚至对于具有写入权限的参与者也是如此。大多数存储库都会保护 main 分支,因此必须作为拉取请求来提交更新。

浏览器内编辑体验最适用于次要或不常见的更改。如果您要进行大量更改或使用高级 Git 功能,我们建议您创建分支存储库并在本地使用

提供反馈

要设置与 Adobe 一样大型的解决方案,文档工作始终任重而道远。如果发现错误,请将问题记录下来;如果想提供有关材料的建议,请告知我们。告诉我们您需要的信息。如果您无法找到所需内容,请告知我们;或者如果您在完成任务时遇到困难,请告诉我们可以如何帮助您了解我们的解决方案。

请接受“协作文档”团队和Experience League中所有作者和内容制作人的谢意。

在此页面上