ps-init

项目文档初始化命令

此命令用于快速初始化项目的文档结构，自动生成 CLAUDE.md 和 docs/ 目录下的各类文档。

使用方法

/ps-init

功能特性

• 智能项目识别：自动识别项目类型（前端/后端/Python/数据分析/Claude插件等）
• 动态文档生成：根据项目类型推荐合适的文档清单
• 文档分层设计：CLAUDE.md 只包含高频使用内容，详细文档放到 docs/
• 增量更新支持：检测已存在文件，避免覆盖用户内容
• 复杂模块检测：识别需要专门文档的复杂模块

执行流程

当你运行此命令时，将执行以下步骤：

1. 项目分析

• 扫描项目配置文件（package.json、requirements.txt 等）
• 分析项目目录结构
• 识别项目类型和技术栈
• 检测复杂模块

2. 文档推荐

根据项目类型推荐文档清单：

前端项目：ARCHITECTURE.md, TESTING.md, DEVELOPMENT.md, TECH_STACK.md, COMPONENTS.md, THEME.md

Node.js 后端：ARCHITECTURE.md, API.md, DATABASE.md, TESTING.md, DEVELOPMENT.md, TECH_STACK.md, DEPLOYMENT.md

Python 后端：ARCHITECTURE.md, API.md, DATABASE.md, TESTING.md, DEVELOPMENT.md, DEPLOYMENT.md

Web3 项目：ARCHITECTURE.md, WALLET_AUTH_IMPLEMENTATION.md, TESTING.md, DEVELOPMENT.md, TECH_STACK.md

数据分析：DATA_SOURCES.md, ANALYSIS_WORKFLOW.md, MODELS.md, TESTING.md

Claude 插件：PLUGIN_STRUCTURE.md, COMMANDS.md, SKILLS.md, HOOKS.md, TESTING.md

通用项目：ARCHITECTURE.md, TESTING.md, DEVELOPMENT.md

3. 交互确认

• 展示识别结果
• 询问用户选择需要的文档
• 确认复杂模块是否需要专门文档

4. 文档生成

• 生成精简的 CLAUDE.md（<500行）
• 生成选定的 docs/ 文档
• 检测文件冲突，询问处理方式

5. 后续指导

• 显示生成的文档清单
• 提供后续建议

生成的文档结构

项目根目录/
├── CLAUDE.md              # 精简版项目文档
└── docs/
    ├── ARCHITECTURE.md    # 架构设计（按需）
    ├── TESTING.md         # 测试规范（按需）
    ├── API.md             # API 文档（按需）
    ├── CONTRIBUTING.md    # 贡献指南（按需）
    └── ...                # 其他文档（按需）

CLAUDE.md 内容

生成的 CLAUDE.md 包含：

• 项目概述（1-2句话）
• 技术栈
• 项目结构（简略）
• 常用命令
• 编码规范（核心规则）
• 📚 详细文档索引（Reference 机制）

Reference 机制

CLAUDE.md 中会包含详细文档索引，引导 AI 在需要时读取对应文档：

## 📚 详细文档索引

当需要了解以下内容时，请阅读对应文档：

- **架构设计和技术选型** → 请阅读 `docs/ARCHITECTURE.md`
- **测试策略和测试用例编写** → 请阅读 `docs/TESTING.md`
- **API 接口定义和使用** → 请阅读 `docs/API.md`

⚠️ **重要**：在开始实现功能前，如果涉及以上领域，请先使用 Read 工具阅读相关文档。

增量更新

如果检测到文件已存在，会询问处理方式：

• 覆盖：用新内容替换现有文件
• 跳过：保留现有文件，不生成新文件
• 合并：尝试合并内容（仅限部分文件）

注意事项

• 生成的文档是模板，需要根据项目实际情况补充完善
• CLAUDE.md 应保持精简，避免占用过多上下文
• 详细内容应放到 docs/ 目录，通过 Reference 机制引用
• 建议定期使用 doc-sync skill 检查文档是否需要更新