与JIRA平台集成
生成需求和设计文档
- 参考快速启动中操作,登录华为云码道代码智能体。
- 在IDE工具顶部菜单栏中,单击“文件(F)”,选择,打开克隆的代码仓库“url-link-extractor”。
- 在华为云码道代码智能体界面选择“规范开发(Spec-Driven)”模式。
- 在聊天界面的输入框中,输入如下指令,单击发送图标
。 需求场景:我需要获取指定URL开头的所有链接,以及这些网页对应的标题。以https://support.huaweicloud.com/usermanual-cli/开头为例,我需要的完整URL链接形如https://support.huaweicloud.com/example.html,网页标题是页面的<title>文本;例如,其中一个链接为https://support.huaweicloud.com/codeartsagent_cli_0001.html,网页标题为“什么是码道CLI”。基于这个需求背景,输出需求设计文档
- 待需求规格设计任务完成后,单击“全部接受”,合入需求文档spec.md文件。
根据AI的答复,您可进入生成路径下检视spec.md文件,确认生成内容是否满足您的要求,如果需要AI继续优化该需求文档,您可在聊天界面继续与AI进行对话交互。
- (可选)例如,本案例希望AI继续优化spec.md文件,则继续在聊天界面的输入框中,输入如下指令,单击发送图标
。 请优化:提取后的链接,不要以.../codeartsagent_cli_0001.html显示,需要以完整的URL展示,例如https://support.huaweicloud.com/usermanual-cli/codeartsagent_cli_0001.html
待AI优化后,可重新查看spec.md文件:
- 若想手动修改,用户可在spec.md文件手动修改完成后,在聊天界面单击“全部接受”。
- 若想使用AI继续优化,可单击“全部接受”后,继续与AI进行对话交互。
- 基于已创建的需求文档,在聊天界面单击“开始实现方案创建”,AI将根据生成设计文档。
- 待创建架构文档任务完成后,单击“全部接受”,合入设计文档design.md文件。
根据AI的答复,您可进入生成路径下查看design.md文件,确认生成内容是否满足您的要求,如果需要AI继续优化该设计文档,您可在聊天界面继续与AI进行对话交互。
- (可选)例如,本案例希望AI继续优化design.md文件,则继续在聊天界面的输入框中,输入如下指令,单击发送图标
。 请优化:输出结果的文件名为result.xlsx,表格要包含爬取后的URL完整链接及页面标题
- 待AI优化后,可重新查看spec.md文件:
- 若想手动修改,用户可在spec.md文件手动修改完成后,在聊天界面单击“全部接受”。
- 若想使用AI继续优化,可单击“全部接受”后,继续与AI进行对话交互。
- 待spec.md文件保存后,单击“开始实现方案创建”,即可继续重新生成对应的design.md文件。
- 待AI优化后,可重新查看spec.md文件:
上传spec.md和design.md
在生成spec.md和design.md文件后,可执行本章节,将spec.md文件上传至JIRA并分配责任人、design.md上传至Confluence,并将design.md。
- 在聊天界面的输入框中,输入如下指令,单击发送图标
。 将spec.md归档到JIRA
- 根据AI的返回提示,选择需要归档的项目后,单击“提交”。本案例选择“devops”项目。
需求文档成功提交至JIRA平台后,AI将返回如下内容:
spec.md 已成功归档到 JIRA: 字段 值 Issue Key KAN-1 项目 devops (KAN) 类型 任务 标题 URL链接标题提取组件 - 需求规格 (spec.md) 链接https://ltest.atlassian.net/browse/KAN-1
- 登录JIRA统一账号登录页。
- 左侧导航栏单击“Jira”,左侧导航栏单击上述创建的项目空间“devops”,进入“devops”空间。
- 单击上述需求文档的待办事项所在行的
,给当前登录账号分配责任人。 - 左侧导航栏单击“Confluence”,进入Confluence首页。
- 左侧导航栏单击“空间”。
- 在弹出框中单击“创建一个空间”,填写“为此空间命名”,本案例填写为“devops-confluence”,选择卡片“知识库”,单击“下一步”,进入“确认您的知识库”页面,此页面的参数保持默认,单击“创建空间”,即可完成知识库空间创建。
空间创建成功后,将自动跳转至“devops-confluence”首页。
- 在码道代码智能体聊天界面的输入框中,输入如下指令,单击发送图标
。 同步design.md文件到Confluence
- 根据AI的返回提示,选择需要归档的空间后,单击“提交”。本案例选择“devops-space”空间。
设计文档成功同步到Confluence后,AI将返回如下内容:
design.md已成功归档到Confluence devops-confluence空间: 字段 值 页面 ID 393218 空间 devops-confluence (devopsconf) 标题 URL链接标题提取组件 - 实现方案 (design.md) 链接 https://jira-test.atlassian.net/wiki/spaces/devopsconf/pages/393218 页面内容包含 design.md 全文(含架构图、状态机、接口清单、类图等 PlantUML 代码块),并在末尾标注了关联的 JIRA issue KAN-1 与文档源文件路径。
- 在聊天界面的输入框中,输入如下指令,单击发送图标
。 获取分配给我的待开发Jira需求
待办事项指派成功,AI将返回如下内容:
分配给您的待开发 Jira 需求共 1 条: 链接:https://test.atlassian.net/browse/KAN-1 报告人/经办人:example 描述:即 spec.md 全文(含 6 大章节、result.xlsx 导出约束、绝对完整 URL 规则等) 这是当前唯一分配给您且未完成的需求。是否需要对它进行状态流转、添加评论或其他操作?
生成tasks.md
在获取到分配的待办事项后,您可以执行本章节完成tasks.md文件生成。
- 在聊天界面的输入框中,输入如下指令,单击发送图标
。 读取对应Confluence的design.md文档,梳理并提炼开发要点
- AI将提炼开发要点,并进入下一阶段,生成tasks.md。
- 待tasks.md文件生成后,单击“全部接受”,合入编码任务规划tasks.md文件。
根据AI的答复,您可进入生成路径下检视tasks.md文件,确认生成内容是否满足您的要求,如果需要AI继续优化该需求文档,您可在聊天界面继续与AI进行对话交互。