Documentation 如何组织有关计划解决方案的信息?

Documentation 如何组织有关计划解决方案的信息?,documentation,service,requirements,interaction,Documentation,Service,Requirements,Interaction,我会的。我开发了一个与证券交易所合作的系统(系统,如下)。我的程序需要很多信息来与这个系统交互。这个系统有正式声明的接口,但是除了声明和对我的系统的需求之外,不同的细节经常被改变。因此,我如何将有关此系统和需求的可用信息组织到我的程序中,使其既易于理解又易于更改。您的首要目标是为您的程序公开的相关API创建文档,然后为配置文件添加文档,甚至可以为配置设置一个验证器 第一步是从代码注释自动生成内容(取决于您的解决方案,它可能是.NET的XML文档或PHPdoc等),这将帮助您在处理代码时记录类和接

我会的。我开发了一个与证券交易所合作的系统(系统,如下)。我的程序需要很多信息来与这个系统交互。这个系统有正式声明的接口,但是除了声明和对我的系统的需求之外,不同的细节经常被改变。因此,我如何将有关此系统和需求的可用信息组织到我的程序中,使其既易于理解又易于更改。

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

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

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

欢迎使用SO。这是难以置信的广泛。请添加更多细节以获得具体答案