怎么用AI生成系统开发文档？

搭建自己的量化系统从软件构思、框架设计、代码开发、直到现在，实现了从系统配置、指标计算到分析数据绘图的一条业务流的功能。至今没有编写较为完整的开发文档。

昨天开始稍微停一停，着手软件开发文档的编制。编写文档这事，我不想自己编写了，决定完全交给AI来完成。

其实，在开发过程中，我利用AI帮我零星地生成过一些开发文档，既不规范也不系统。而且，从文档质量来看，不甚满意。

昨天就想着，指标配置系统的核心计算模块，逻辑比较复杂，若等功能完善再去编写文档，也不知道会到什么时候。阶段性地完成相关的文档，会更好一些，自己需要的时候还能回顾阅读。

借助AI编写文档，我的操作过程是这样的。

一、准备好已经可以发布的代码模块，用于提供给AI模型；

因为我不想自己敲字写文档，所以，我将所有代码提交给AI去阅读，利用AI的阅读理解和分析能力，编制文档应该比我人工去编写更高效。

考虑到过去让AI编写代码的能力不足，需要对AI编写文档时，附加一些提示词，来引导和规范AI的撰文。

二、编写Prompt提示词；

生成系统架构的Prompt提示词为：

请作为系统架构师，请根据下述要求生成架构文档。** 基础要求**参看: 文档公共信息.txt**文档要求包含：**1. 架构风格与模式（MVC、微服务、事件驱动等）2. 技术栈说明（前端、后端、数据库、中间件）3. 系统组件图与职责划分4. 模块依赖关系5. 数据流设计6. 部署架构7. 扩展性与容错设计

这个提示词指导AI在生成文档时，应该包含哪些章节内容，确保文档信息全面和清晰。其中，我将较为共性的提示信息保存到 文档公共信息.txt 文件中。

三、修正和完善文档内容

AI大模型根据提示词执行代码阅读和文档编写工作，代码文件较多，需要耐心等待AI理解代码库并编写文档。

文档生成之后，请务必认真阅读生成的文档所描述的内容是否与代码库中的实际业务逻辑、技术实现逻辑一致。

为什么一定要阅读呢？因为我发现AI大模型在编写文档时，会瞎编乱造。本次文档生成，我使用Trae，发现生成的文档中，不但没有将软件核心代码的真实架构描述出来，意外的在文档中看到了很多与代码库中毫不相干的架构和代码逻辑，瞎编了很多填充篇幅的内容。

这是让我非常意外的。说明AI大模型胡说八道这件事，真不是子虚乌有的事情。

今天，我换Qoder来生成文档，首次生成的质量高于Trae，整体上还能围绕代码库编写。

我自己过了一遍生成的文档，然后告诉AI哪里需要完善、哪些需要删除。经过几轮的修改后，文档达到了个人可以接受的程度。

比如，在技术方案部分，我会给出简单的提示词，补充相应的内容：

我发现一个问题，文档描述不够详细，比如缺少输入输出的内容描述，数据枚举等，请完善这些信息

当然，补充的信息提示，完全根据文档中缺失的内容来调整，不必拘泥于我的提示词。如果你能给出更加细致准确的提示，AI给出的文档质量将会更加让人满意。

下面是我让AI生成的用户手册的信息，包含了模块介绍，快速开始（软硬件要求、安装部署、首次使用）、功能详解和常见问题解答（FAQ）,像模像样的。

文档目录导航

文档内容

唯一不足的是，每个章节的介绍都是浅显的一句话一笔带过，深度不够。还需要基于具体的细节进行精准的提示，进一步下钻到具体的功能点进行生成。

如果你有更加专业的、细致的开发文档模板，可以将模板提供给AI，让大模型根据文档模板的结构和内容要素去编制文档，这样会让你的开发文档生成事半功倍。

对于我的量化系统文档来说，完成了计算引擎的文档生成，可以继续完成GUI应用——指标配置管理系统(beta)的文档编制了，这个应用基于计算引擎开发，具有指标配置、指标测试计算、分析模板配置和模板测试模块，实现了从财报数据csv文件导入数据进行测试的功能，也算是一个较为完整的配置软件。