pix-develop-docs
📂 基础信息
| 属性 | 值 |
|---|---|
| 名称 | pix-develop-docs |
| 版本 | 1.0.0 |
| 类型 | 项目分析技能 |
| 核心功能 | 生成演进式开发文档 |
| 适用环境 | Trae |
| 适用项目 | 所有开发项目（语言无关） |
🎯 核心目标
通过"重新实现"的方式帮助理解复杂项目，从需求角度出发，采用演进式开发思路，生成结构化的开发文档。文档展示如何从零开始，逐步构建项目，帮助开发者深入理解项目的设计思路和实现细节。
解决的问题
| 痛点 | 解决方案 |
|---|---|
| 项目复杂难以理解 | 拆解为多个演进阶段，逐步深入 |
| 不清楚设计决策原因 | 从需求出发，解释每个决策的背景 |
| 缺乏系统性文档 | 生成标准化的开发文档序列 |
| 难以把握整体架构 | 从框架搭建到功能完善，循序渐进 |
🚀 使用方法
激活方式
当用户询问以下类型的问题时，pix-develop-docs 会自动激活：
- •"分析这个项目并生成开发文档"
- •"帮我理解这个项目的架构"
- •"生成项目的演进式开发文档"
- •"从零开始重新实现这个项目"
- •"创建项目开发文档"
工作流程
- •项目扫描：读取项目代码，分析目录结构和技术栈
- •需求分析：识别核心功能和业务需求
- •功能拆解：将项目拆解为多个演进阶段
- •文档生成：生成 00_ 前缀的 markdown 文档序列
预期输出
生成以下文档序列（00_ 前缀递增）：
- •
00_项目概述与需求分析.md - •
01_核心功能拆解.md - •
02_阶段一_框架搭建.md - •
03_阶段二_核心功能实现.md - •
04_阶段三_功能扩展与优化.md - •
05_阶段四_完善与细节处理.md - •
06_总结与最佳实践.md
📋 文档结构规范
文档命名规则
- •格式：
NN_标题.md - •NN：两位数字，从 00 开始递增
- •标题：使用中文，描述文档内容
文档内容规范
每个文档包含以下部分：
- •概述：本阶段的目标和范围
- •需求分析：当前阶段需要实现的需求
- •技术方案：采用的技术方案和设计决策
- •实现步骤：详细的实现步骤和代码示例
- •关键决策：重要设计决策的原因说明
- •验证方法：如何验证本阶段的实现
🌟 文档模板
00_项目概述与需求分析.md
markdown
# 项目概述与需求分析 ## 项目背景 [项目背景说明] ## 核心需求 [核心需求列表] ## 技术栈概览 [技术栈说明] ## 项目结构 [目录结构说明]
01_核心功能拆解.md
markdown
# 核心功能拆解 ## 功能模块划分 [功能模块列表] ## 依赖关系 [模块依赖图] ## 优先级排序 [功能优先级说明]
02_阶段一_框架搭建.md
markdown
# 阶段一：框架搭建 ## 目标 [本阶段目标] ## 需求分析 [当前需求] ## 技术方案 [技术方案说明] ## 实现步骤 1. [步骤1] 2. [步骤2] 3. [步骤3] ## 关键决策 [决策说明] ## 验证方法 [验证方法]
03_阶段二_核心功能实现.md
markdown
# 阶段二：核心功能实现 ## 目标 [本阶段目标] ## 需求分析 [当前需求] ## 技术方案 [技术方案说明] ## 实现步骤 [详细实现步骤] ## 关键决策 [决策说明] ## 验证方法 [验证方法]
04_阶段三_功能扩展与优化.md
markdown
# 阶段三：功能扩展与优化 ## 目标 [本阶段目标] ## 需求分析 [当前需求] ## 技术方案 [技术方案说明] ## 实现步骤 [详细实现步骤] ## 关键决策 [决策说明] ## 验证方法 [验证方法]
05_阶段四_完善与细节处理.md
markdown
# 阶段四：完善与细节处理 ## 目标 [本阶段目标] ## 需求分析 [当前需求] ## 技术方案 [技术方案说明] ## 实现步骤 [详细实现步骤] ## 关键决策 [决策说明] ## 验证方法 [验证方法]
06_总结与最佳实践.md
markdown
# 总结与最佳实践 ## 项目总结 [项目整体总结] ## 设计模式 [使用的设计模式] ## 最佳实践 [最佳实践列表] ## 经验教训 [经验教训]
🔧 实现指南
分析步骤
- •
扫描项目结构
- •识别主要目录和文件
- •分析技术栈和依赖
- •理解项目架构
- •
识别核心功能
- •分析主要入口文件
- •识别关键模块和类
- •理解业务逻辑
- •
拆解演进阶段
- •确定最小可行产品（MVP）
- •识别功能依赖关系
- •规划演进路径
- •
生成文档
- •按模板生成每个阶段的文档
- •包含代码示例和决策说明
- •确保文档连贯性
代码分析要点
- •入口分析：找到程序入口点，理解启动流程
- •依赖分析：分析依赖关系，理解模块交互
- •数据流分析：追踪数据流动，理解业务逻辑
- •关键算法：识别核心算法，理解实现原理
文档编写要点
- •需求驱动：每个阶段从需求出发，解释为什么这样做
- •循序渐进：从简单到复杂，逐步深入
- •代码示例：提供关键代码片段，帮助理解
- •决策说明：解释重要设计决策的原因
- •验证方法：提供验证实现的方法
📚 最佳实践
分析阶段
- •从整体到局部：先理解整体架构，再深入细节
- •关注核心路径：优先分析核心业务流程
- •记录疑问：记录不理解的地方，后续深入分析
文档编写
- •保持连贯性：确保各阶段文档的逻辑连贯
- •使用图表：适当使用图表辅助说明
- •代码注释：代码示例要有清晰注释
- •避免冗余：避免重复相同内容
质量保证
- •逻辑检查：确保演进路径合理
- •完整性检查：确保覆盖所有核心功能
- •可读性检查：确保文档易于理解
🎓 使用示例
示例 1：分析 Web 应用项目
用户请求："分析这个 Web 应用项目并生成开发文档"
响应：
- •扫描项目结构，识别前端、后端、数据库等模块
- •分析核心功能：用户认证、数据管理、API 接口等
- •拆解演进阶段：
- •阶段一：基础框架搭建
- •阶段二：用户认证功能
- •阶段三：数据管理功能
- •阶段四：API 接口和优化
- •生成 00_ 到 06_ 的文档序列
示例 2：分析后端服务项目
用户请求："帮我理解这个后端服务项目"
响应：
- •扫描项目结构，识别服务层、数据层、工具层等
- •分析核心功能：请求处理、数据存储、业务逻辑等
- •拆解演进阶段：
- •阶段一：服务框架搭建
- •阶段二：核心业务逻辑
- •阶段三：数据存储和查询
- •阶段四：性能优化和监控
- •生成 00_ 到 06_ 的文档序列
🔍 技术栈识别
常见技术栈识别
| 文件/目录 | 技术栈 |
|---|---|
| package.json | Node.js/JavaScript |
| requirements.txt | Python |
| pom.xml | Java (Maven) |
| build.gradle | Java (Gradle) |
| go.mod | Go |
| Cargo.toml | Rust |
| composer.json | PHP |
| Gemfile | Ruby |
框架识别
| 文件/目录 | 框架 |
|---|---|
| next.config.js | Next.js |
| vite.config.js | Vite |
| webpack.config.js | Webpack |
| tsconfig.json | TypeScript |
| .svelte-kit/ | SvelteKit |
| nuxt.config.js | Nuxt.js |
📝 注意事项
- •语言无关：适用于所有编程语言和框架
- •灵活调整：根据项目特点调整文档结构
- •持续更新：项目变化时及时更新文档
- •用户友好：确保文档易于理解和跟随
🚀 扩展性
可以根据项目特点添加额外的文档：
- •
07_部署与运维.md - •
08_测试策略.md - •
09_性能优化.md - •
10_扩展开发.md
🎯 总结
pix-develop-docs 是一个强大的项目分析技能，通过演进式开发文档帮助开发者深入理解复杂项目。从需求出发，逐步构建，让项目的设计思路和实现细节变得清晰易懂。
记住，好的开发文档应该：
- •需求驱动：从需求出发，解释设计决策
- •循序渐进：从简单到复杂，逐步深入
- •代码示例：提供关键代码片段
- •决策说明：解释重要设计决策的原因
- •易于跟随：让读者能够跟随文档重新实现项目