如何组织关于程序解决方案的信息？

Question

Неllо。我开发与证券交易所合作的系统（系统，见下文）。我的程序需要与系统进行交互的信息很多。这个系统有正式的声明接口，但是除了这个声明和对我的系统的要求之外，不同的细节经常改变。那么，如何组织有关该系统的可用信息和我的程序的要求，以便它们易于理解并易于更改。

Answer 1

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

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

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