开发人员的工作效率对我们来说意义重大，为了让客户和合作伙伴比以往更容易使用我们的软件，我们去年启动了一个项目，将移动服务产品领域的所有文档整合在一起。今天，我很自豪地宣布，我们在SAP help portal上发布了新的整合文档的第一个版本，同时发布了一个非常棒的移动服务介绍视频。感觉自己被邀请去看一看，或者继续阅读来了解我们过去面临的问题、新文档背后的想法以及我们实施的改进。

从历史上看，我们的每个团队都会拥有并编写他们认为合适的文档：基于这样的假设，这是有意义的：，可视化数据大屏，在使用我们的服务和SDK时，我们文档的读者往往只关注一个平台，比如移动开发工具包。然而，像这样散开的文档在过去也会导致一系列尴尬的情况：毕竟，我们构建和分发的软件和SDK都以这样或那样的方式围绕着移动服务功能。让我们以推送通知为例：我们的一些工具提供绑定，即特定于平台的api，用于在Android和iOS上使用推送通知。其他的则为您提供了编写移动优化后端OData服务的方法，而这些服务又可以通过businessevents触发推送通知。但是，以前以工具为中心的文档集都没有提供对推送通知的端到端概述：如何触发推送通知、移动服务如何处理推送通知以及客户端开发人员如何使用推送通知向用户提供信息。虽然这些问题的答案分散在各个文档集上，但我们将其作为练习留给读者，让读者拼凑信息并形成一个概述。我相信这也体现在我过去几年与客户的各种互动中：在某些情况下，我很惊讶我们的某些功能被误解了，我认为这一定是我们解释事物的方式导致了从外部角度看时的混乱。基于这个原因，我们开始分析我们出版的资产，并思考如何使我们的作品更易于消化，听说过康威定律："设计系统的组织……被限制生产这些组织通信结构的复制品。"因此，我们创造资产的方式可能并不理想。我发现，以前，我们创建文档的方式，我开玩笑地喜欢称之为一个中文耳语游戏：开发人员会以某种方式编写原始指南或参考内容，然后将其发送给用户辅助专家进行编辑和润色。生成的文档将在上发布help.sap.com帮助，我们很好。还是我们？

让我感到奇怪的是，内容专家（开发者）和发布的资产之间有一定的距离。我在开源领域已经做了大量的工作，因此我习惯于使用由开发人员编写的文档，这些文档本来是供其他开发人员使用的。通常情况下，当某个问题不起作用或没有解释时，您会打开一个问题并获得直接反馈，因此文档会更新以避免问题再次发生。这种反馈循环不适用于我们的方法。此外，编辑很难判断所提供的信息是否足以满足目标受众的需求：毕竟他们是编辑专家，而不是产品专家，这让我意识到我们在内容创作过程中需要涉及不同的视角，我们决定采用一种内部源代码方法，在这种方法中，文档将以降价方式重写，并在所有团队都参与的中心Git存储库中进行管理。它不仅使审阅更加透明和可跟踪（我们现在使用pull请求而不是邮件线程），还使我们组织的其他人员（例如最初请求某个功能的人员）更容易参与我们的内容审阅。还有一系列我们不满意的问题：一方面，内容结构在我们看来似乎不是为了帮助客户实现目标，而是为了描述我们工具的结构—库、组件和API。另一方面，物联网智能水表，我们代表了整个SAP的移动战略，但我觉得我们的帮助内容可以更好地进行移动优化。最后但并非最不重要的一点是，每个团队在编写文档时采用的方法略有不同，这使得读者很难从一组文档转移到另一组文档，什么叫云服务，也很难轻松找到类似的信息。

几个月后快进：我们为文档实施了全新的内容结构和主题，旨在解决所有这些问题。自动检查确保了每个团队的一致性和正确性，而且由于内容是并排的，因此将新创建的内容与我们已有的内容进行协调比以往任何时候都要容易。

但这并不是我们停止的地方–当前的版本只是我们展示社区对我们有多重要的第一个里程碑。我们仍在迁移所有内容，尤其是SAP Mobile Cards、SAP Mobile Development Kit和SAP Cloud Platform SDK for iOS，并将旧文档重定向到新文档。此外，目前的文件只有英文版本，我们正在努力尽快提供其他语言的翻译文本。一旦这样做了，我们有一个额外的内容，我们想提供，我们觉得没有得到适当的解决在过去的一长串。最后但并非最不重要的一点——因为我提到了开放源码——我们正在寻找方法来打开我们的文档，以供外部贡献。当然，软件企业条件，这并不意味着我们要在写作和编辑内容上投入更少的精力，因为我们希望其他人能修复它。但是，阅读和使用我们的文档来构建优秀软件的人很可能是第一批发现内容差距、措辞不清晰或其他问题的人，他们使用我们的新工具和内部流程，我们希望尽可能容易地提供反馈，并以更直接和现代的方式解决内容问题。

请随时关注本项目的最新情况，淘客宝，并在评论中分享您的想法！

更新2020-04-14：更新视频链接