documentation - 如何组织有关程序解决方案的信息？

Question

Неll®。我开发了适用于证券交易所的系统（系统，如下）。我的程序需要与这个系统交互有很多信息。这个系统有正式声明的接口，但是这个声明旁边的不同细节和对我系统的要求经常改变。那么，我如何才能组织有关该系统的可用信息以及对我的程序的要求，以使其既易于理解又易于更改。

Answer 1

您的首要目标是为您的程序公开的相关 API 创建文档，然后为配置文件添加文档，甚至可能为配置设置一个验证器。

从代码注释自动生成内容（取决于您的解决方案，可能是 .NET 的 XML 文档或 PHPdoc 等）是第一步——这将帮助您在处理代码时记录类和接口。下一步是记录非代码资产。例如，如果您有 XML 配置，则可以编写模式进行验证。

之后是集成文档——需要在生产服务器和/或工作站上执行以安装、升级和维护应用程序的步骤，包括支持脚本。