# Initial

> 分析当前代码库并用中文撰写CLAUDE.md文件，为未来的Claude Code实例提供项目操作指南。触发场景：用户输入/initial命令、新项目首次初始化、需要生成项目指南文件时使用。

- Skill: `leeyorke/initial` (Agent Skill)
- Install (CLI): `npx skillmds@latest add leeyorke/initial`
- Raw SKILL.md: https://api.skillmd.com/api/skills/leeyorke/initial/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: leeyorke (https://skillmd.com/u/leeyorke)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/leeyorke/initial

---


# /initial 命令使用说明
## 功能
自动分析当前代码库的**结构**、**构建流程**、**架构设计**，生成标准化的CLAUDE.md文件，供后续Claude Code实例快速理解项目结构和开发流程。

## CLAUDE.md 要求规范
### 文件开头固定格式（必须严格遵循）

```markdown
# CLAUDE.md

本文件为 Claude Code (claude.ai/code) 在处理此存储库中的代码时提供指导。
```

### 必须包含的内容
#### 1. 常用命令部分
收集并整理项目开发全流程的常用命令：
- 开发环境搭建命令（安装依赖、初始化配置等）
- 代码质量检查命令（lint、format、类型检查等）
- 测试命令（运行全量测试、运行单个测试、生成覆盖率报告等）
- 构建/编译命令
- 本地运行/调试命令
- 部署/发布命令
- 其他项目特有的常用命令

#### 2. 高等级架构部分
总结需要阅读多个文件才能理解的大局架构：
- 项目核心定位、技术栈
- 整体目录结构说明（核心模块的功能划分）
- 关键架构设计原则和模式
- 核心流程的运行机制（例如请求处理流程、数据流向等）
- 重要的设计决策和背后的原因
- 项目特有的约定和规范

### 禁止包含的内容（重要！）
- 不要包含显而易见的通用开发实践（比如"写单元测试"、"不要提交敏感信息"等）
- 不要包含可以通过简单搜索发现的文件结构细节
- 不要重复README.md中已有的用户导向内容, 如果涉及其他文档，直接给出参考路径即可。
- 不要包含模板化的通用内容，所有内容必须是本项目特有的

## 执行步骤
1. 首先查看项目根目录的关键文件：README.md、pyproject.toml/package.json/Makefile、CONTRIBUTING.md等
2. 探索项目目录结构，理解核心模块划分
3. 查找构建、测试、lint相关的配置文件和脚本
4. 分析核心代码的架构设计和依赖关系
5. 按照上述规范生成CLAUDE.md文件，保存到项目根目录
6. 完成后向用户总结生成的内容要点