tongtonytony 概要设计说明书生成技能
基于「AI赋能项目管理：特定行业/项目的概要设计说明书的关键组件生成」（2601课程案例第156篇）的方法论，支持为任意行业、任意项目生成规范的概要设计说明书，含业务架构图、架构概览图、组件图、部署图等 PlantUML 脚本。
触发场景
当用户表达以下意图时应用本技能：
- 需要生成/编写概要设计说明书
- 需要编写软件设计说明书、系统架构设计
- 提及「概要设计」「概要设计说明书」「Outline Design Specification」
- 需要业务架构图、架构概览图、组件图、部署图
- 需要基于需求规格说明书生成设计文档
工作流程
第一步：互动式信息收集
在生成概要设计说明书之前，必须先以对话方式收集以下必要信息。若用户未一次性提供，则逐项询问：
必填信息
| 信息项 | 说明 | 示例 |
|---|---|---|
| 项目名称 | 项目/系统的正式名称 | 基于RAG的AI智能客服系统 |
| 关联需求规格说明书 | 需求规格说明书（PRD）的文件内容或核心内容摘要 | 用户上传文件、粘贴文本或提供文件路径 |
建议收集的扩展信息
| 信息项 | 说明 | 是否必填 |
|---|---|---|
| 行业/领域 | 项目所属行业 | 建议必填 |
| 技术栈 | 拟采用的技术框架、语言、中间件 | 建议必填 |
| 部署环境 | 云/本地、容器化、服务器配置 | 建议必填 |
| 外部系统集成 | 需对接的第三方系统、接口方式 | 按需 |
| 非功能性约束 | 性能、安全、可用性等设计约束 | 按需 |
一次性录入表单
若用户希望一次性提供基础信息，可引导其使用本技能目录下的 input-form.html，在浏览器中打开、填写后点击「生成可复制文本」，将结果粘贴到 Cursor 对话中。注意：关联的需求规格说明书仍需另行上传或粘贴。
互动询问示例
- 项目名称：请问您要生成概要设计说明书的项目名称是什么？
- 需求规格说明书：请提供关联的需求规格说明书内容。您可以：
- 上传需求规格说明书文件（.docx、.md、.txt）
- 粘贴需求规格说明书的核心内容
- 提供工作区内的文件路径，由我读取
- 输出格式：您是否有公司或客户指定的 Word 模板格式？若有，请上传或指定路径；若无，将按「基于RAG的AI智能客服项目交付样例」格式输出。
第二步：确定输出格式
- 用户提供自定义 Word 格式：若用户上传或指定了公司/客户的 Word 模板（.docx），则严格按照该模板的章节结构、样式、标题层级输出。
- 默认格式：若用户未提供自定义格式，则按照「基于RAG的AI智能客服项目交付样例（业务架构图+架构概览图+组件图+部署图）.docx」的结构和层级输出。完整结构见 reference.md。
第三步：生成概要设计说明书
- 依据需求规格说明书：从需求规格说明书中提取功能性需求、非功能性需求、系统上下文、用例、参与者等信息，作为设计输入。
- 按选定格式填充：按模板或默认格式填充各章节内容。
- 生成 PlantUML 脚本：为以下四类图生成 PlantUML 脚本，嵌入文档或单独输出：
- 业务架构图：展示业务模块、业务流程、角色与系统关系
- 架构概览图：展示系统分层、模块划分、主要技术选型
- 组件图：展示核心组件、组件间依赖与接口
- 部署图：展示部署节点、运行环境、网络拓扑
- 行业适配：行业术语、技术描述应与用户所述行业及需求规格说明书一致。
- 缺失标注：若信息不足，对缺失条目标注「[待补充：XXX]」，并提示用户后续补充。
第四步：输出与修订
- 输出格式：优先生成
.docx文件；若不支持直接生成 Word，则输出结构完整、表格清晰的 Markdown，便于用户复制到 Word。 - PlantUML 脚本：将 PlantUML 脚本以代码块形式嵌入文档，标注「可复制到 PlantUML 工具中渲染」。
- 中文表述：全文使用中文，避免错别字、乱码；数字、单位、日期格式符合中文习惯。
- 若用户需调整某部分，根据反馈单独修订并保持整体一致。
概要设计说明书核心结构（默认）
默认采用「概要设计说明书模板样例」的章节结构，并结合「基于RAG的AI智能客服项目交付样例」的图表输出，包含以下部分：
- 引言：目的、范围、定义、参考资料
- 总体设计：设计目标、设计原则、技术选型
- 业务架构图：PlantUML 脚本 + 图说明
- 架构概览图：PlantUML 脚本 + 图说明
- 组件设计：组件图 PlantUML 脚本 + 组件说明表
- 部署设计：部署图 PlantUML 脚本 + 部署说明
- 接口设计：主要接口定义
- 数据结构设计：核心数据结构（可选）
- 非功能性设计：性能、安全、可扩展性等
详细字段说明与 PlantUML 示例见 reference.md。
参考文件路径
- 模板参考：工作区内的「概要设计说明书模板样例.doc」（定义章节结构）
- 交付格式参考：工作区内的「基于RAG的AI智能客服项目交付样例（业务架构图+架构概览图+组件图+部署图）.docx」（默认采用此格式输出）
- 需求输入：关联的「需求规格说明书」或「基于RAG的AI智能客服项目的交付样例（含需求矩阵、用例图和用例描述样例）.docx」
- 一次性录入 UI：本技能目录下的 input-form.html
注意事项
- 不臆造：未收集到的技术栈、部署环境、组件名称等，不得编造，应标注待补充或使用占位符。
- 需求追溯：概要设计中的模块、组件、接口应与需求规格说明书中的需求、用例保持追溯关系。
- PlantUML 可执行：生成的 PlantUML 脚本应语法正确，可在 PlantUML 在线或本地工具中直接渲染。
- 行业适配：政务类强调合规、数据安全；金融类强调审计、风控；医疗类强调隐私、监管；企业应用可侧重易用性与集成。
- 格式规范：标题层级清晰（一级、二级、三级），表格结构完整，便于在 Word 中进一步排版。