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

Question

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

Answer 1

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

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

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