使用AI辅助写设计文档的感受与一些经验总结

( Owed by: 春夜喜雨 http://blog.csdn.net/chunyexiyu )

使用AI写文档时，感觉还是比较累的，生成的内容是需要等待的，如果不符合预期，感觉自己白白等待了。

过程中，有煎熬，也有收获，还有一些经验。

1. 关于AI生成文档

1.1 问题：生成文档时，通常到达一定长度时，就会中断。

这时，有两个选择：

处理方法1：第一个，告诉它 “继续往下生成文档”，可能行，也可能不行，ai可能又从头开始生成，又到这个地方中断，也可能继续生成了。

处理方法2：还有一种方法，告诉它"继续往下生成文档，生成到一个新文档中"，这种肯定会继续往下生成文档，不会从新生成；坏处时，到时需要自己手动做文档的合并。

2. 关于图形生成与定制：

2.1 问题：生成图形时，ai生成的图形通常都是markdown格式的图形，按照Left to Right生成，生成的比较宽，不适合放入文档中。

此时的话，可以这样来处理：

处理方法1：查看图形的code，如果生成的图形，开头是flowchart LR，把LR去掉，然后再view查看图形，就会转成上下结构了。

处理方法2：把flowchart的图形代码修改后，交给ai生成一遍图形，然后导出图形使用。

处理方法3（推荐）：还有一个方式，可以定制图形的样式的，查看图形flowchart的图形代码，复制下来，使用https://mermaid.live/edit网站来查看与编辑。

2.2 mermaid网站导出图形方法：

mermaid网站使用1：选项的Edit in Playground选项到达https://mermaid.ai/play能够改theme，改背景，也能编辑图形，还能导出图片，不过这个有限额，需要登录。

mermaid网站使用2（推荐）：在https://mermaid.live/edit网站复制图形代码，能在选项中改dark mode是否启用，在Actions选项中也能导出图片。

3. 关于文档创作的步骤

感觉使用AI辅助做软件设计文档创作，可以分为三个步骤来做。

第一阶段：准备阶段–准备模板，梳理个人对模块的理解。

• 准备文档的模板；
• 基于自己的理解，对软件做一个个人理解的架构评估、关注点评估，输出简要的模块理解；

第二阶段：Ai提取文档–使用ai从代码中提取设计文档，并补充架构图、流程图。

• 提示AI基于软件代码，按照模板生成设计文档；
• 提示AI生成架构图，流程图，生成markup格式；
• 文档补充流程图图片，可以使用mermaid网站生成流程图图片；

第三阶段：整合文档–整合个人理解与原设计资料文档，纠错文档与整合文档。

• 纠错–纠正AI理解错误的地方，读取AI生成的文档，基于自己对模块的理解，修正文档的错误部分；
• 如果有原设计资料文档，把原设计资料关注的点，重要的部分，移植到生成的文档中；
• 梳理处理个人理解、AI文档、原设计资料不一致的点，修正文档；

( Owed by: 春夜喜雨 http://blog.csdn.net/chunyexiyu )