# claude-skills-example **Repository Path**: boost-learning/claude-skills-example ## Basic Information - **Project Name**: claude-skills-example - **Description**: 一个基于 Claude Skills 的完整软件开发流程（SDLC）规范模板项目。提供了从需求分析到交付的全流程文档模板和最佳实践，帮助团队建立规范的 AI 辅助开发流程。 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-12-29 - **Last Updated**: 2026-01-05 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Claude AI 开发规范模板项目 [![Claude Skills](https://img.shields.io/badge/Claude-Skills-blue)](https://platform.claude.com/docs/en/agents-and-tools/agent-skills) [![Best Practices](https://img.shields.io/badge/Best_Practices-Official-green)](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE) 一个基于 Claude Skills 的完整软件开发流程（SDLC）规范模板项目。提供了从需求分析到交付的全流程文档模板和最佳实践，帮助团队建立规范的 AI 辅助开发流程。 ## 📋 项目简介 本项目旨在为使用 Claude AI 进行软件开发的团队提供一套完整的、符合官方最佳实践的规范模板。通过标准化的文档结构、清晰的工作流程和可追溯的交付物，确保 AI 辅助开发的质量和一致性。 ### 核心特性 - ✅ **完整的 SDLC 流程**：覆盖需求、设计、实施、测试、交付5个阶段 - ✅ **双轨制文档管理**：历史记录 + 项目总档，既保留完整历史又维护最新状态 - ✅ **符合官方最佳实践**：遵循 [Claude Skills 官方最佳实践](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) - ✅ **渐进式披露**：简洁的主流程文档 + 详细的模板文件 - ✅ **用户确认机制**：每个阶段都有明确的验证和确认点 - ✅ **质量保证**：内置测试策略、验收标准和质量门禁 ### 适用场景 - 软件团队建立 AI 辅助开发规范 - 项目标准化文档管理流程 - 提高 Claude AI 辅助开发的效率和质量 - 新手学习如何使用 Claude Skills ## 🎯 项目目标 1. **标准化流程**：建立统一的 AI 辅助开发流程，减少团队协作成本 2. **提升质量**：通过规范化的文档和测试，确保交付质量 3. **可追溯性**：完整记录每个需求的开发历史，便于回顾和审计 4. **知识沉淀**：将开发经验固化为模板，持续改进 ## 📂 项目结构 ``` claude-skills-example/ ├── .claude/ │ └── skills/ │ └── managing-sdlc/ # SDLC 管理技能 (v2.0.0) │ ├── SKILL.md # 主流程文档 (653行，已优化) │ ├── references/ # 详细参考文档 │ │ ├── examples.md # 使用示例 │ │ ├── workflows.md # 工作流程详情 │ │ └── state-management.md # 状态管理详解 │ ├── assets/ # 模板文件 │ │ ├── requirements-template.md # 需求文档模板 │ │ ├── design-template.md # 技术设计文档模板 │ │ ├── acceptance-testing-template.md # 验收测试策略模板 │ │ ├── test-report-template.md # 测试报告模板 │ │ └── project-docs-update-guide.md # 项目总档更新指南 │ └── scripts/ # 辅助脚本 │ └── validate-state.py # 状态文件验证脚本 ├── docs/ # 项目文档（使用时生成） │ ├── PRD.md # 项目需求总档 │ ├── design.md # 项目设计总档 │ ├── acceptance-testing.md # 项目验收标准总档 │ ├── test-report.md # 项目测试报告总档 │ └── log/ # 历史记录目录 │ └── [YYYYMMDD-需求名称]/ │ ├── 01-requirements.md │ ├── 02-design.md │ ├── 03-acceptance-testing.md │ └── 04-acceptance-test-report.md ├── src/ # 源代码（使用时生成） ├── tests/ # 测试代码（使用时生成） ├── README.md # 本文件 ├── LICENSE # MIT 许可证 └── .gitignore # Git 忽略文件 ``` ## 🚀 快速开始 ### 1. 安装 Claude Code 确保已安装 Claude Code CLI。参考：[Claude Code 文档](https://code.anthropic.com) ### 2. 复制 Skill 到你的项目 ```bash # 方法1：直接复制 skill 目录 cp -r .claude/skills/managing-sdlc /你的项目/.claude/skills/ # 方法2：作为全局 skill 使用 cp -r .claude/skills/managing-sdlc ~/.claude/skills/ ``` ### 3. 使用 Skill 在 Claude Code 中提出需求： ``` 我需要开发一个用户登录功能 ``` Claude 将自动触发 `managing-sdlc` skill，并引导你完成： 1. 需求澄清和 PRD 生成 2. 技术设计和测试策略 3. 代码实施 4. 测试和迭代 5. 交付和文档更新 ## 📖 详细使用指南 ### Skill 触发方式 #### 自动触发 当你的请求包含以下关键词时，skill 会自动触发： - "开发新功能" - "实现需求" - "PRD" / "设计文档" / "测试策略" - "SDLC" / "开发流程" - "验收标准" / "测试报告" #### 手动调用 ```bash # 在 Claude Code 中 claude "使用 managing-sdlc skill 开发一个订单管理功能" ``` ### 工作流程详解 #### 阶段1：需求与规划 ``` 用户: 我想添加一个用户登录功能 Claude: 1. 创建目录: docs/log/20251229-user-login/ 2. 澄清需求: - 认证方式偏好？(JWT/OAuth/Session) - 需要收集哪些用户信息？ - 有什么安全要求？ 3. 生成需求文档: docs/log/20251229-user-login/01-requirements.md 4. 请求确认: 请审查并批准需求文档 ``` #### 阶段2：技术设计 ``` 用户: 需求批准了，可以开始设计 Claude: 1. 讨论技术方案: - 前端框架？ - 后端架构？ - 数据库选择？ 2. 生成设计文档: docs/log/20251229-user-login/02-design.md 3. 生成测试策略: docs/log/20251229-user-login/03-acceptance-testing.md 4. 确认测试框架: Jest / pytest / JUnit ? 5. 请求确认: 请审查并批准设计文档 ``` #### 阶段3：实施 ``` Claude: 1. 创建执行计划: - 设计数据模型 - 实现认证逻辑 - 创建 API 端点 - 编写单元测试 2. 使用 TodoWrite 跟踪进度 3. 实施编码 4. 构建验证 ``` #### 阶段4：测试与迭代 ``` Claude: 1. 执行所有测试 2. 生成测试报告: docs/log/20251229-user-login/04-acceptance-test-report.md 3. 如果有失败: - 识别问题 - 修复问题 - 重新测试 4. 迭代直到所有测试通过 ``` #### 阶段5：交付与更新 ``` Claude: 1. 确保所有文档完整 2. 展示交付成果: - ✅ 需求文档 - ✅ 设计文档 - ✅ 测试策略 - ✅ 测试报告 3. 请求批准: 可以更新项目总档吗？ 4. 更新项目总档: - docs/PRD.md - docs/design.md - docs/acceptance-testing.md - docs/test-report.md 5. 完成交付 ``` ## 🎨 自定义和扩展 ### 修改模板 1. **根据团队规范调整模板** ```bash # 编辑模板文件 vim .claude/skills/managing-sdlc/templates/requirements-template.md ``` 2. **添加自定义章节** - 在模板中添加团队特定的章节 - 修改验收标准以符合团队流程 ### 创建新的 Skill 参考本项目创建你自己的 skill： 1. **创建 skill 目录** ```bash mkdir -p .claude/skills/your-skill ``` 2. **创建 SKILL.md** ```yaml --- name: your-skill description: What it does and when to use it --- ``` 3. **遵循最佳实践** - 保持 SKILL.md 简洁（< 500行） - 使用渐进式披露 - 添加示例和检查清单 ## 📚 文档模板说明 ### 需求文档模板 (requirements-template.md) **用途**：记录产品需求、功能定义和验收标准 **关键章节**： - 概述与背景 - 功能需求（M0/M1/M2 优先级） - 用户故事 - 非功能需求 - 成功标准 **输出**：`docs/log/[日期-需求]/01-requirements.md` ### 设计文档模板 (design-template.md) **用途**：记录技术架构、组件设计和接口定义 **关键章节**： - 系统架构 - 组件设计 - 数据模型 - API 设计 - 安全设计 - 性能优化 **输出**：`docs/log/[日期-需求]/02-design.md` ### 验收测试策略模板 (acceptance-testing-template.md) **用途**：定义测试策略、测试用例和验收标准 **关键章节**： - 验收标准（M0/M1/M2） - 完成定义 (DoD) - 测试金字塔（单元/集成/E2E） - 性能/安全测试（可选） - 回归测试 **输出**：`docs/log/[日期-需求]/03-acceptance-testing.md` ### 测试报告模板 (test-report-template.md) **用途**：记录测试执行结果和缺陷情况 **关键章节**： - 执行摘要 - 验收标准检查 - 测试结果详情 - 缺陷报告 - 质量趋势 **输出**：`docs/log/[日期-需求]/04-acceptance-test-report.md` ### 项目总档更新指南 (project-docs-update-guide.md) **用途**：指导如何更新项目级别的总档文档 **关键章节**： - 更新步骤 - 检查清单 - 注意事项 **更新文档**： - `docs/PRD.md` - `docs/design.md` - `docs/acceptance-testing.md` - `docs/test-report.md` ## 🤖 AI 使用指南 ### AGENTS.md - AI Agent 专用指南 [AGENTS.md](AGENTS.md) 专门为 AI Agent 设计，包含： - ✅ **触发条件**：何时自动触发 skill - ✅ **工作流程**：5个阶段的详细执行步骤 - ✅ **检查清单使用**：如何使用进度跟踪 - ✅ **关键原则**：必须遵守的规则 - ✅ **错误处理**：常见错误及解决方案 - ✅ **响应风格**：推荐的响应格式 - ✅ **工具使用**：如何使用各种工具 - ✅ **输出格式**：标准化的输出模板 ### CLAUDE.md - Claude AI 专属指南 [CLAUDE.md](CLAUDE.md) 专为 Claude AI 优化，包含： - ✅ **模型适配**：针对 Claude Opus/Sonnet/Haiku 的建议 - ✅ **提示技巧**：如何有效使用本 skill - ✅ **思考模式**：复杂场景处理方法 - ✅ **性能优化**：Token 和响应优化 - ✅ **智能特性**：上下文感知、学习偏好 - ✅ **文档生成技巧**：模板填充和内容定制 - ✅ **常见陷阱**：避免的错误和问题 ### 使用建议 **对于 AI Agent 开发者**： - 阅读 AGENTS.md 了解如何集成此 skill - 参考工作流程和错误处理部分 - 使用提供的响应模板 **对于 Claude AI 用户**： - 阅读 CLAUDE.md 了解最佳实践 - 学习提示技巧提高效率 - 参考智能特性优化体验 **对于项目维护者**： - 两个文档都可作为维护和改进的参考 - 包含完整的工作流程说明 - 提供故障排除指南 ## 🎓 最佳实践 ### 1. 需求阶段 ✅ **DO:** - 问"为什么"以理解真实需求 - 使用示例和场景来澄清 - 明确记录假设 - 区分 M0/M1/M2 优先级 ❌ **DON'T:** - 跳过需求澄清直接实施 - 假设用户意图 - 忽略约束条件 ### 2. 设计阶段 ✅ **DO:** - 提前考虑边界情况 - 考虑可维护性和可扩展性 - 与用户验证可行性 - 记录技术决策和权衡 ❌ **DON'T:** - 过度设计 - 忽视错误处理 - 跳过安全考虑 ### 3. 实施阶段 ✅ **DO:** - 频繁提交，提交信息有意义 - 标记完成前在本地运行测试 - 保持变更聚焦和最小化 - 遵循项目编码规范 ❌ **DON'T:** - 一次性提交大量代码 - 跳过测试直接提交 - 混合多个功能的修改 ### 4. 测试阶段 ✅ **DO:** - 测试边界情况，不只是快乐路径 - 适当地模拟外部依赖 - 测试失败模式，不只是成功 - 迭代直到所有测试通过 ❌ **DON'T:** - 只测试正常流程 - 忽略覆盖率要求 - 跳过回归测试 ### 5. 交付阶段 ✅ **DO:** - 对限制保持透明 - 记录未完成的内容 - 建议未来改进 - **确保项目总档准确反映最新状态** ❌ **DON'T:** - 隐藏已知问题 - 不更新文档 - 跳过用户验收 ## 🔄 文档管理策略 ### 双轨制 本项目采用双轨制文档管理： **历史记录轨** (`docs/log/`) - 每次需求创建独立目录：`docs/log/YYYYMMDD-需求名称/` - 包含4个完整文档：需求、设计、测试策略、测试报告 - 保留完整历史，便于追溯 **项目总档轨** (`docs/`) - 维护项目最新状态 - 每次需求完成后更新 - 简洁摘要，详细内容指向历史记录 ### 更新原则 1. **仅当用户明确批准后，才更新项目总档** 2. **总档应该是简洁的摘要，详细内容在历史记录中** 3. **每次更新都要记录变更历史和指向历史记录的链接** ## 🔧 配置和设置 ### 环境要求 - Claude Code CLI（最新版本） - Git（用于版本控制） - 测试框架（根据项目选择）：Jest / pytest / JUnit / go test ### 可选配置 #### 自定义测试框架 在 `03-acceptance-testing.md` 中指定： ```markdown **测试框架**: Jest / pytest / JUnit / go test ``` #### 自定义文档路径 修改 `SKILL.md` 中的路径配置： ```markdown docs/log/YYYYMMDD-需求名称/ ``` #### 自定义质量门禁 在 `03-acceptance-testing.md` 中修改： ```markdown - 单元测试覆盖率: ≥ 80%（可调整） - 性能要求: P95 < 200ms（可调整） ``` ## 🤝 贡献指南 我们欢迎任何形式的贡献！ ### 如何贡献 1. **Fork 本仓库** 2. **创建特性分支** (`git checkout -b feature/AmazingFeature`) 3. **提交更改** (`git commit -m 'Add some AmazingFeature'`) 4. **推送到分支** (`git push origin feature/AmazingFeature`) 5. **开启 Pull Request** ### 贡献类型 - 🐛 Bug 修复 - ✨ 新功能 - 📝 文档改进 - 🎨 代码优化 - ♻️ 重构 - ✅ 测试补充 ### 开发规范 1. **遵循现有代码风格** 2. **添加测试覆盖新功能** 3. **更新相关文档** 4. **一个 PR 只做一件事** 5. **提交信息清晰明确** ## 📄 许可证 本项目采用 MIT 许可证 - 详见 [LICENSE](LICENSE) 文件 ## 🙏 致谢 - [Claude Skills 官方文档](https://platform.claude.com/docs/en/agents-and-tools/agent-skills) - [Claude Skills 最佳实践](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/best-practices) - [awesome-claude-skills](https://github.com/VoltAgent/awesome-claude-skills) ## 📮 联系方式 - 项目主页：[GitHub Repository] - 问题反馈：[GitHub Issues] - 讨论交流：[GitHub Discussions] ## 🗺️ Roadmap ### v1.0（当前版本） - ✅ 完整的 SDLC 流程 - ✅ 双轨制文档管理 - ✅ 符合官方最佳实践 - ✅ 渐进式披露设计 - ✅ 工作流检查清单 - ✅ 示例和反馈循环 ### v1.1（计划中） - [ ] 添加实用脚本自动化 - [ ] 添加更多项目类型示例 - [ ] 创建评估测试套件 - [ ] 添加国际化支持 ### v2.0（未来） - [ ] Web UI 界面 - [ ] 与 CI/CD 集成 - [ ] 团队协作功能 - [ ] 指标和统计面板 --- **Made with ❤️ for better AI-assisted development** 如果这个项目对你有帮助，请给一个 ⭐️ Star！