init - 项目初始化 / CLAUDE.md 技能

Claude Code 内置技能 — 为新项目创建标准化 CLAUDE.md 文件

一、技能概述

init 是 Claude Code 的内置技能,用于在项目中初始化一份结构化的 CLAUDE.md 文件。该文件是 Claude Code 的项目级指令中心,定义了代码库的规范、约定和自动化流程,让 AI 助手在协作时能够准确理解项目上下文,做出符合团队期望的决策。

执行方式:在 Claude Code 对话中输入 /init 即可触发该技能。技能会自动扫描当前项目结构,生成包含代码库概况、技术栈、构建命令、约定规范等内容的标准文档。

核心价值: 一份好的 CLAUDE.md 文件相当于项目的"宪法",让 AI 工具与人类开发者共享同一套规则,大幅减少沟通成本和理解偏差。

二、技能用途

init 技能的主要用途是为新项目创建或初始化 CLAUDE.md 文件。具体而言,它解决以下问题:

提示: init 技能适用于全新项目的初始化阶段。对于已有 CLAUDE.md 的存量项目,可使用 claude-md-management:revise-claude-md 技能进行审计和优化。

三、CLAUDE.md 包含的内容

一份完整的 CLAUDE.md 文件通常包含以下几个核心部分:

# 项目名称 ## 概述 本项目用于 ... ## 技术栈 - 语言: Python 3.12 - 框架: FastAPI - 数据库: PostgreSQL 16 ## 命令 - `make test` — 运行测试 - `make build` — 构建项目 ## 规范 - 命名: snake_case - 类型注解: 必须

四、init 技能的工作原理

当用户触发 /init 命令时,Claude Code 会执行以下步骤:

  1. 扫描项目根目录: 检测已存在的配置文件(package.jsonCargo.tomlpyproject.tomlgo.mod 等),从中推断技术栈。
  2. 分析目录结构: 观察代码文件布局,识别主要模块和功能区域。
  3. 生成草稿: 基于扫描结果,生成一份包含项目概览、技术栈、目录结构的基础文档。
  4. 交互确认: 与用户对话,补充缺失的信息(如编码规范、特定流程等)。
  5. 写入文件: 将最终内容写入项目根目录的 CLAUDE.md
注意: init 技能生成的是基础骨架。最佳实践是在此基础上持续迭代,随着项目演进不断丰富和更新 CLAUDE.md 内容。

五、生成文件的结构

init 技能生成的 CLAUDE.md 遵循标准 Markdown 格式,结构如下:

# <项目名称> ## 概述 (项目的核心定位和功能简述) ## 技术栈 (编程语言、框架、基础设施等) ## 常用命令 (构建、测试、运行等命令) ## 目录结构 (主要目录及其用途说明) ## 编码规范 (命名约定、文件组织等) ## 工作流程 (自动化流程和操作指南)

该结构可根据项目实际需要进行调整和扩展。建议在初始化后,根据团队需求添加更多定制化章节。

六、适用场景

init 技能在以下场景中尤为适用:

最佳实践: 即使项目只有你一个人维护,CLAUDE.md 也值得编写。三个月后的你,相当于半个"新人"——项目文档是你和未来自己沟通的桥梁。

七、最佳实践

基于实际使用经验,以下是编写和维护 CLAUDE.md 的几点建议:

八、核心要点总结

1. init 技能用于为新项目创建 CLAUDE.md 文件。
2. CLAUDE.md 是 AI 协作的"项目宪法",定义规范和流程。
3. 典型内容包括:技术栈、命令、目录结构、编码规范、工作流程。
4. 触发方式:在 Claude Code 中输入 /init
5. 最佳实践:简洁、可操作、持续更新、版本控制。
6. 配合 revise-claude-md 技能可进行持续优化。

九、与相关技能的比较

Claude Code 提供了多个围绕 CLAUDE.md 的技能,它们各有侧重:

建议配合使用:用 init 初始化,用 revise-claude-md 迭代更新,用 claude-md-improver 做质量审计。