使用AI辅助写设计文档的感受与一些经验总结
( Owed by: 春夜喜雨 http://blog.csdn.net/chunyexiyu )使用AI写文档时感觉还是比较累的生成的内容是需要等待的如果不符合预期感觉自己白白等待了。过程中有煎熬也有收获还有一些经验。1. 关于AI生成文档1.1 问题生成文档时通常到达一定长度时就会中断。这时有两个选择处理方法1第一个告诉它 “继续往下生成文档”可能行也可能不行ai可能又从头开始生成又到这个地方中断也可能继续生成了。处理方法2还有一种方法告诉它继续往下生成文档生成到一个新文档中这种肯定会继续往下生成文档不会从新生成坏处时到时需要自己手动做文档的合并。图示方法1方法2-推荐生成文档时到达一定长度中断告诉它 ‘继续往下生成文档’告诉它继续往下生成文档生成到一个新文档中2. 关于图形生成与定制2.1 问题生成图形时ai生成的图形通常都是markdown格式的图形按照Left to Right生成生成的比较宽不适合放入文档中。此时的话可以这样来处理处理方法1查看图形的code如果生成的图形开头是flowchart LR把LR去掉然后再view查看图形就会转成上下结构了。处理方法2把flowchart的图形代码修改后交给ai生成一遍图形然后导出图形使用。处理方法3推荐还有一个方式可以定制图形的样式的查看图形flowchart的图形代码复制下来使用https://mermaid.live/edit网站来查看与编辑。图示方法1方法2方法3-推荐图形宽度过长修改图形codeView查看修改图形code交给ai生成图形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选项中也能导出图片。图示是否导出PNG复制图形使用图形背景色是否使用深色模式点击选项启用darkmode点击选项禁用darkmode选择Actions按钮导出图片或复制图片选择PNG按钮选择Copy Image按钮3. 关于文档创作的步骤感觉使用AI辅助做软件设计文档创作可以分为三个步骤来做。第一阶段准备阶段–准备模板梳理个人对模块的理解。准备文档的模板基于自己的理解对软件做一个个人理解的架构评估、关注点评估输出简要的模块理解第二阶段Ai提取文档–使用ai从代码中提取设计文档并补充架构图、流程图。提示AI基于软件代码按照模板生成设计文档提示AI生成架构图流程图生成markup格式文档补充流程图图片可以使用mermaid网站生成流程图图片第三阶段整合文档–整合个人理解与原设计资料文档纠错文档与整合文档。纠错–纠正AI理解错误的地方读取AI生成的文档基于自己对模块的理解修正文档的错误部分如果有原设计资料文档把原设计资料关注的点重要的部分移植到生成的文档中梳理处理个人理解、AI文档、原设计资料不一致的点修正文档图示第一阶段准备阶段--准备模板梳理个人对模块的理解第二阶段Ai提取文档--使用ai从代码中提取设计文档并补充架构图、流程图第三阶段整合文档--整合个人理解与原设计文档纠错文档与整合文档( Owed by: 春夜喜雨 http://blog.csdn.net/chunyexiyu )