我在IT部门工作了17年，大部分时间是作为一名顾问，但还没有看到一家公司的技术文档是最新的和可靠的。我认为文档不是最新的一个主要原因是文档的维护远离源代码，例如存储在单独的solutionmanager系统中的大量Word文档。在本文中，西安大数据，我将解释Git存储库中处理的降价文件如何使文档更接近ABAP源代码。由于在GitHub上很活跃，我最近经常发现自己在编辑降价文件。我发现降价更容易更快地写。在Git存储库中搜索大量降价文件也比在文档管理系统中扫描大量Word文档容易得多。为什么我们不能使用Markdown来记录ABAP开发？

工具

我们使用Azure DevOps和abapGit来控制ABAP代码的版本。我们决定使用相同的工具来管理降价格式的技术文档。我的标记文件编辑器是Visual Studio代码，返利微信，带有几个与标记相关的扩展名。

工作流程

我的工作流程在进行开发和编写文档时通常是这样的：

文档级别

通常我们为每个包创建一个标记文件，并根据文件包的名称命名文件文件。例如，在创建一个标记文件来记录与名为ZACTIVITY的活动相关的包时，标记文件应放在包文件夹中（例如src/zactivity/），并应命名为活动.md。请注意，文件名必须小写，大量数据，因为abapGit否则会引发以下问题中描述的错误，例如，将文件添加到文件中的ignore标记时。abapgit.xml文件.

一般情况下，代码应不言自明，不需要通过注释或降价文件的大量文档。Markdown文档应该给不熟悉包的另一个开发人员一个包的概述，例如描述代码在哪个进程中被使用以及它解决了什么问题。我们通常试图记录在编写代码时做出的重要设计决策，并突出显示所使用的设计模式。如果存在与其他包的依赖关系，也会对这些依赖关系进行描述。我们试图保持文档的简短，并将其视为应该为读者指出正确方向的东西，而不是广泛地解释每个实现细节。为了帮助开发人员编写一致的文档，我们创建了一个带有标题和提示的降价模板，这些标题和提示可能与文档中包含的内容相关。

搜索文档

从结构上来说，文档很容易找到，因为它是在代码附近维护的。在azuredevops中，搜索整个存储库或跨多个存储库也很方便。通过使用条件，可以将搜索限制为仅包括标记文件分机：md in搜索框

结论

我认为，将降价文件与Git管理的存储库结合使用，可以在保持文档活力方面取得很好的效果。文档离代码很近，企业交流软件，易于查找、维护和查看。

文档编写愉快！

这篇博文最早出现在开发者的博客上https://www.developervoyage.com/2020/12/19/using-markdown-to-document-abap-code.html

，大数据是做什么的