pdlc-onboard
Solid新人引导 / 自动化生成用户手册
AI & Automation 16 stars
2 forks Updated yesterday MIT
Install
Quality Score: 85/100
Stars 20%
Recency 20%
Frontmatter 20%
Documentation 15%
Issue Health 10%
License 10%
Description 5%
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 -->
为新加入项目的开发者生成引导文档,帮助快速上手。
## 工作流程
1. 扫描整个项目结构,了解当前状态
2. 运行 `make status` 查看服务和应用列表
3. 阅读 `CLAUDE.md`、`README.md` 获取项目概述
4. 汇总输出新人引导信息
## 输出内容
### 1. 项目总览
- 项目名称和用途
- 技术栈概述
- 微服务列表及各自职责
- 前端应用列表及各自职责
### 2. 环境搭建
- 必要的开发工具和版本要求
- 本地开发环境搭建步骤
- 配置文件说明
### 3. 开发规范
- 引用 `docs/00_standards/coding-standards.md`(未命中 → 提示 `consider /pdlc-standard add coding/<topic>`)
- Git 分支策略和提交规范
- PDLC 工作流说明
### 4. 快速上手
- 如何运行项目
- 如何运行测试
- 如何创建新功能(指向 `/new-feature` 命令)
- 常用 Make 命令一览
### 5. 关键文档索引
- 列出 `docs/` 下所有重要文档的路径和摘要
### 6. 常见问题
- 构建失败怎么办
- 测试报错怎么排查
- 如何联调
## 要求
<!-- @include templates/prompts/output-language.md(已内联于下方,无需另读) -->
🌐 **Output language for generated artifacts**
All generated artifacts (PRDs, design docs, code comments, review reports,
test plans, deployment manuals, changelog entr...
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