一、功能概述
麦芽 AI 支持根据产品原型、系统分支、数据库、参考资料,自动生成需求文档、接口文档、设计说明、方案报告等专业文档,输出规范、结构完整、可直接交付研发使用,大幅提升文档编写效率。
二、创建文档
(一)进入创建入口
点击“AI建文档”或顶部导航栏“文档”,进入文档管理列表点击“新建文档”,进入文档创建页
(二)输入需求提示词
在文本输入框输入你的提示词
输入提示词时需尽可能详细、准确地描述你期望生成文档的要求。你也可以在输入框中添加参考网页原型、文档、数据库和系统分支,以便麦芽AI生成更符合需求的文档
🌟纯文本提示词
例如,你可以输入以下提示,生产一个移动端的旅游行程规划APP的需求文档:
我要设计一个移动端的旅游规划APP,需要支持目的地的添加,生成多种旅行方案,并推荐最佳酒店区域选址。请根据以上内容帮我生成一份需求文档
(三)添加参考附件
🌟参考附件
1.参考原型
支持选择已在系统中设计的原型项目与迭代版本作为参考附件,系统会根据原型样式及功能设计文档内容
2.参考文档
支持选择文档库中已有的文档参考进行文档设计
3.参考数据库
支持选中已连接的数据库资源进行文档设计
4.参考工程分支
支持选择已接入的git库中的工程进行文档设计
二、麦芽AI 自动生成文档
麦芽AI收到你的文档需求之后,将立即启动需求分析,逐步生成对应文档内容,并提供文档的一级菜单快速定位功能
三、文档调整与编辑
🌟可基于整个文档提出调整需求
例如,你可以按照以下提示修改文档内容:
完善功能需求详细说明章节,增加各功能需求的详细逻辑描述
1.终止
点击可终止正在执行中的任务
2. 参考附件
输入框输入调整需求时,支持上传网页原型、参考文档、参考数据库和参考系统分支作为文档修改参考附件
3. 技能选择
支持选用多种技能,让麦芽AI 执行需求任务时将严格遵循技能规则输出结果
4. 模型选用
支持自定义模型,根据不同的需求内容选择最合适的大模型,使得输出内容更正确
5. 文档分组调整
未执行需求时,点击下拉框支持选择文档分组
6. 文档编辑
支持直接选中文档内容进行修改编辑
7. 文档名称编辑
支持选择文档名称直接进行修改编辑
8. 调整章节顺序
支持拖拽左侧章节标题进行章节快捷排序
9. 字体调节框
支持选择文本内容进行统一调整
四、版本管理与协作
(一)版本管理
AI 每一个需求执行完毕,文档都会新增一个版本,点击版本管理支持查看文档的历史编辑记录,并支持查看差异、版本对比,来看各个版本之间的文档差异,以快速定位 AI 所修改的文档具体内容
1. 版本对比
可快速定位到 两个版本的差异位置,查看新增、删除、修改的内容,并支持回滚到某一个历史版本
2. 同步
支持选择文档已绑定项目或新增项目,一键同步当前版本文档内容至各需求对话框,可快速同步更新最新的接口文档与开发需求