系统设计与架构构思通常涉及多步骤的对话迭代——从生成高层用例模型到详细阐述具体的交互序列。捕捉这些设计讨论的完整上下文以及底层的绘图脚本,对于维护清晰的软件文档至关重要。Visual Paradigm使团队能够将整个 AI 绘图会话直接导出为 Markdown 格式。
本指南演示了如何使用 AI 聊天机器人构建多绘图工作流,并将完整的对话历史(包括文本说明和“绘图即代码”脚本)导出为干净、可直接用于文档的 Markdown 文件。
将 AI 会话导出为 Markdown 的主要优势
将对话式设计会话导出为 Markdown 为开发人员、系统分析师和技术文档撰写者带来了多项关键优势:
- 完整上下文保留:保留整个构思过程,从初始提示和结构修订到详细的组件说明。
- 原生支持“绘图即代码”:自动将基于代码的绘图格式(如 PlantUML、Mermaid 和 Graphviz)与说明文本一起打包。
- 开发环境集成:无缝打开导出的
.md文件,以便在 VS Code 等代码编辑器中进行本地编辑和基于 Git 的版本控制。
- 大语言模型与流水线可读性:将干净的 Markdown 文件输入外部 AI 模型或文档平台,例如OpenDocs 编辑器进行进一步分析和发布。
分步指南:构建和导出 AI 绘图会话
步骤 1:生成初始用例图
打开AI 聊天机器人工具,在Visual Paradigm Online或您的桌面环境中。输入提示以构建基线模型,例如:“为 ATM 系统生成 UML 用例图。”AI 引擎将立即渲染系统边界、参与者和核心用例。
步骤 2:在同一会话中使用序列图进行迭代
通过在同一个对话线程中深入探讨特定的系统行为,保持会话的连续性:
- 向聊天机器人发出提示:“为‘取款’用例创建一个序列图。”
- AI 引擎会在您之前的图表正下方生成顺序消息交换、生命线以及激活块。
步骤 3:请求 AI 对关键组件进行解释
向聊天机器人澄清架构职责和组件角色:
- 输入类似以下的查询:“解释此序列中 ATM 控制器生命线的角色。”
- AI 会在聊天时间线内直接返回详细的技术分解。
步骤 4:将对话导出为 Markdown
要导出完整的会话历史记录:
- 点击导出会话选项,并选择Markdown (.md).
- 聊天机器人将所有文本提示、技术响应和基于代码的图表脚本打包成一个结构化的 Markdown 文档。
- 在 VS Code 或您首选的文本编辑器中打开导出的文件,以查看结构化的代码块和系统说明。
软件文档的实际应用
- 架构决策记录 (ADRs):将技术设计讨论和权衡与生成的可视化模型一起归档。
- 版本控制仓库:将图表代码和会话日志直接提交到 Git 仓库,以实现持续的文档跟踪。
- 统一发布管道:将导出的 Markdown 文件直接导入到OpenDocs以便将对话洞察纳入企业架构手册。
今天就开始简化您的设计文档
捕捉架构构思工作流的每一步,轻松将 AI 绘图会话转化为结构化的 Markdown 文档。
探索工具,从今天开始文档化: