design-outline

设计辅助 - 文档大纲与契约

提供技术设计阶段的辅助能力，帮助产出高质量的技术设计文档。

1. 文档大纲生成

触发词：生成大纲、文档骨架、设计模板

输入：需求描述 / Jira Key

执行步骤：

1. 如提供 Jira Key，使用 jira_get_issue 获取需求详情
2. 分析需求类型（新功能开发 / 功能迭代 / 技术优化）
3. 按 doc-template.md 模板生成标准大纲

输出：标准技术设计文档大纲，包含以下章节：

• 背景与目标（业务背景、设计目标、术语说明）
• 需求分析（功能需求、非功能需求、约束与限制）
• 系统架构（整体架构、方案对比矩阵、模块划分）
• 详细设计（接口设计、数据模型、核心流程）
• 非功能设计（性能、异常处理、安全、监控）
• 兼容性与迁移（功能迭代时必填）
• 风险与应对

根据需求类型自动裁剪可选章节，并在每个章节标注编写要点提示。

2. API 契约表格生成

触发词：API 清单、接口文档、契约表

输入：JSON 示例 / Controller 代码 / Swagger 文档

执行步骤：

1. 从输入中提取接口信息
2. 对照 standards/api-design-standards.md 校验规范性
3. 生成格式化接口明细表

输出：

接口清单总览

#	接口名称	Method	路径	说明

每个接口的详情

#### {接口名称}

- **路径**：{Method} {Path}
- **说明**：{功能说明}
- **幂等性**：{是/否，及实现方式}

**请求参数**

| 参数名 | 位置 | 类型 | 必填 | 说明 |
|--------|------|------|------|------|

**响应字段**

| 字段名 | 类型 | 说明 |
|--------|------|------|

**错误码**

| 错误码 | 说明 | 处理建议 |
|--------|------|----------|

规范校验结果

对照 API 设计规范检查 URL 命名、HTTP 方法使用、幂等性设计等，输出校验结果。

3. 架构方案对比

触发词：方案对比、架构选型、技术选型

输入：2-3 个候选方案描述

输出：

## 架构方案对比

| 维度 | 方案 A: {名称} | 方案 B: {名称} | 方案 C: {名称} |
|------|----------------|----------------|----------------|
| 方案概述 | | | |
| 性能 | | | |
| 可扩展性 | | | |
| 可维护性 | | | |
| 实现成本 | | | |
| 风险 | | | |
| 综合评分 | ⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐ |

### 推荐方案：{方案名}

**推荐理由**：{综合分析}

**注意事项**：{选用该方案需要关注的问题}

对比维度说明：

• 性能：响应时间、吞吐量、资源消耗
• 可扩展性：横向扩展能力、新需求适配成本
• 可维护性：代码复杂度、调试难度、团队熟悉度
• 实现成本：开发工作量、学习成本、依赖引入
• 风险：技术风险、运维风险、兼容性风险

参考资料

• 文档模板：doc-template.md - 技术设计文档标准模板
• 接口规范：standards/api-design-standards.md