← ClaudeAtlas

pdlc-designlisted

创建技术设计文档(自动生成 + 自检 + handoff)
kanfu-panda/pdlc-skills · ★ 7 · AI & Automation · score 83
Install: claude install-skill kanfu-panda/pdlc-skills
# 创建设计文档 <!-- @include templates/prompts/iron-law.md --> 根据已有的需求文档,在 `docs/02_design/` 对应子目录下创建技术设计文档。 ## 输入解析 从 `$ARGUMENTS` 中判断输入类型: - **文件路径**(以 `/`、`./` 开头,或以 `.md`、`.txt`、`.pdf` 结尾,或实际存在的文件):直接读取该文件作为需求来源,跳过 PRD 搜索 - **功能名关键词**(默认):按下方守卫检查搜索 PRD ## PDLC 前置检查(必须执行,不可跳过) 1. 若输入为文件路径,直接读取文件内容作为需求,提取功能名和功能ID(如有),跳到步骤 4 2. 从用户输入中提取功能名称关键词 3. 在 `docs/01_requirements/prd/` 目录下搜索包含该关键词的 PRD 文档 - 匹配新格式:`F<日期>-<NN>-*<关键词>*-prd.md` - 匹配旧格式:`YYYYMMDD-*<关键词>*-prd.md` - 同时检查文件内容中是否包含该关键词 3. **未找到** → 输出以下信息后**立即停止,不继续执行**: ``` ⛔ PDLC 守卫:未找到与「<功能名>」相关的 PRD 文档。 设计文档必须基于已有的 PRD。请先运行: 👉 /pdlc-prd <需求描述> ``` 4. **找到** → 提取功能ID(如 `F20260326-01`),读取该 PRD 内容,继续执行 ## 输出位置 - API 设计 → `docs/02_design/api/` - 架构设计 → `docs/02_design/architecture/` - 数据库设计 → `docs/02_design/database/` ## 要求 1. 先阅读找到的 PRD 文档,全面理解需求 2. 参考 `templates/api-design-template.md` 获取 API 设计模板格式 3. 参考 `docs/00_standards/` 目录了解项目规范(未命中 → 提示 `consider /pdlc-standard add <category>/<topic>`) 4. **文件名格式**: `<功能ID>-<功能名>-<类型>.md`(如 `F20260326-01-user-auth-api.md`),类型可以是 api / arch / db - 若 PRD 为旧格式无功能ID,则使用旧格式 `YYYYMMDD-<功能名>-<类型>.md` 5. **文档顶部必须包含 PDLC 追溯头**: ``` <!-- PDLC-TRACE --> <!-- 功能ID: F20260326-01 --> <!-- 功能名称: user-auth --> <!-- 阶段: 设计 --> <!-- 前置文档: docs/01_requirements/prd/F20260326-01-user-auth-prd.md --> ``` <!-- @include templates/prompts/output-language.md --> 7. 必须包含:概述、接口/架构/表结构定义、错误码/异常处理、数据模型 8. API 设计需遵循 RESTful 规范,统一响应格式 `{ code, message, data }` 9.