pdlc-design

Solid

创建技术设计文档(自动生成 + 自检 + handoff)

AI & Automation 16 stars 2 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
41
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# 创建设计文档 <!-- @include templates/prompts/iron-law.md(已内联于下方,无需另读) --> ⛔ **IRON LAW · 不可违反的硬门禁** 以下规则为**不可协商**的执行约束: 1. **文件必须落盘**:所有带编号(功能ID / 缺陷ID)的文档,必须作为实际文件写入磁盘,不可仅在对话中输出。 2. **阶段必须落章**:每个阶段完成后必须在状态机 `docs/.pdlc-state/<feature-id>.json` 追加 history,不可跳过。 3. **测试必须存在**:进入 `/pdlc-implement` 前,对应测试必须存在且处于红灯状态。违反则中止。 4. **自检必须执行**:段二自检为强制步骤,不得以"已经很好了"为由跳过。 5. **防循环**:段三修复为单次,不递归。无法自动修复的问题记录到报告,继续往下走。 6. **状态必推进**:成功执行某 phase 后 `current_stage` 必须变更。收尾时若发现 `current_stage` 未推进,视为失败并报错,**不得静默返回**(防止外层循环拿滞后的状态空转烧额度)。唯一例外:命中人工点主动 block 时,`current_stage` 保持不变但必须写 `last_phase_result.ok=false` + `blocked_reason`。 **违反任一条 = 立即中止当前命令,输出违规详情,等待人工介入。** <!-- @include-end templates/prompts/iron-law.md --> 根据已有的需求文档,在 `docs/02_design/` 对应子目录下创建技术设计文档。 ## 输入解析 从本命令的参数中判断输入类型: - **文件路径**(以 `/`、`./` 开头,或以 `.md`、`.txt`、`.pdf` 结尾,或实际存在的文件):直接读取该文件作为需求来源,跳过 PRD 搜索 - **功能名关键词**(默认):按下方守卫检查搜索 PRD ## PDLC 前置检查(必须执行,不可跳过) 1. 若输入为文件路径,直接读取文件内容作为需求,提取功能名和功能ID(如有),跳到步骤 4 2. 从用户输入中提取功能名称关键词 3. 在 `docs/01_requirements/prd/` 目录下搜索包含该关键词的 PRD 文档 - 匹配新格式:`F<日期>-<编号>-*<关键词>*-prd.md` - 匹配旧格式:`YYYYMMDD-*<关键词>*-prd.md` - 同时检查文件内容中是否包含该关键词 3. **未找到** → 输出以下信息后**立即停止,不继续执行**: ``` ⛔ PDLC 守卫:未找到与「<功能名>」相关的 PRD 文档。 设计文档必须基于已有的 PRD。请先运行: 👉 /pdlc-prd <需求描述> ``` 4. **找到** → 提取功能ID(如 `F20260326-090000`),读取该 PRD 内容,继续执行 ## 输出位置 - API 设计 → `docs/02_design/api/` - 架构设计 → `docs/02_design/architecture/` - 数据库设计 → `docs/02_design/database/` ## 要求 1. 先阅读找到的 PRD 文档,全面理解需求 2. 参考 本 skill 目录下的 `a...

Details

Author
kanfu-panda
Repository
kanfu-panda/pdlc-skills
Created
4 months ago
Last Updated
yesterday
Language
Shell
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category