菜单
按最佳实践创建或更新 CLAUDE.md 文件，以便为 AI agent 提供最优的项目入门上下文
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
| name | claude-md |
| description | 按最佳实践创建或更新 CLAUDE.md 文件，以便为 AI agent 提供最优的项目入门上下文 |
$ARGUMENTS
在继续之前，你必须先考虑用户输入（如果不为空）。用户可能会指定：
create - 从零创建新的 CLAUDE.mdupdate - 改进已有的 CLAUDE.mdaudit - 分析并报告当前 CLAUDE.md 的质量src/api/CLAUDE.md 代表目录级说明）LLM 是无状态的：CLAUDE.md 是每次对话中唯一会自动包含的文件。它是让 AI agent 了解代码库的主要入门文档。
少即是多：前沿 LLM 大约能遵循 150-200 条指令。Claude Code 的系统提示词本身已经占了大约 50 条，因此 CLAUDE.md 必须聚焦且简洁。
只放通用信息：只包含每次会话都适用的内容。任务特定的说明应该放在单独文件里。
不要把 Claude 当成 lint 工具：风格指南会膨胀上下文并降低指令遵循效果。应改用确定性工具（如 prettier、eslint 等）。
绝不自动生成：CLAUDE.md 是 AI harness 中杠杆最高的位置。应该经过认真思考后手工编写。
首先分析当前项目状态：
检查是否存在已有的 CLAUDE.md 文件：
./CLAUDE.md 或 .claude/CLAUDE.md**/CLAUDE.md~/.claude/CLAUDE.md识别项目结构：
查看已有文档：
围绕三个维度组织 CLAUDE.md：
对于较大的项目，建议创建 agent_docs/ 文件夹：
agent_docs/
|- building_the_project.md
|- running_tests.md
|- code_conventions.md
|- architecture_decisions.md
在 CLAUDE.md 中引用这些文件，并写明：
关于详细的构建说明，请参考 `agent_docs/building_the_project.md`
重要：使用 file:line 引用，而不是代码片段，以避免上下文过时。
创建或更新 CLAUDE.md 时：
一个结构良好的 CLAUDE.md 应包含：
# 项目名称
一句简短的项目描述。
## 技术栈
- 主语言和版本
- 关键框架/库
- 数据库/存储（如有）
## 项目结构
[仅适用于 monorepo 或复杂结构]
- `apps/` - 应用入口
- `packages/` - 共享库
## 开发命令
- 安装：`command`
- 测试：`command`
- 构建：`command`
## 关键约定
[只保留非显而易见、高影响的约定]
- 约定 1，简要说明
- 约定 2，简要说明
## 已知问题 / 坑点
[经常让开发者踩坑的内容]
- 问题 1
- 问题 2
不要包含：
在最终确定前，检查：
create 或默认模式：update：audit：如果用户请求创建或更新 AGENTS.md：
AGENTS.md 用于定义专门的 agent 行为。与 CLAUDE.md（项目上下文）不同，AGENTS.md 定义的是：
同样适用以下原则：
Комплексне код-рев'ю з аналізом безпеки, продуктивності та якості. Використовуйте, коли користувачі просять переглянути код, проаналізувати якість коду, оцінити pull request, або згадують код-рев'ю, аналіз безпеки чи оптимізацію продуктивності.
Review code toàn diện với phân tích bảo mật, hiệu suất, và chất lượng. Sử dụng khi người dùng yêu cầu review code, phân tích chất lượng code, đánh giá pull requests, hoặc đề cập đến review code, phân tích bảo mật, hoặc tối ưu hóa hiệu suất.
提供全面的代码审查能力，覆盖安全、性能和代码质量分析。适用于用户请求代码审查、代码质量评估、Pull Request 审查，或提到安全分析和性能优化时。
Comprehensive code review with security, performance, and quality analysis. Use when users ask to review code, analyze code quality, evaluate pull requests, or mention code review, security analysis, or performance optimization.
Interactive lesson-level quiz for Claude Code tutorials. Tests understanding of a specific lesson (01-10) with 8-10 questions mixing conceptual and practical knowledge. Use before a lesson to pre-test, during to check progress, or after to verify mastery. Use when asked to "quiz me on hooks", "test my knowledge of lesson 3", "lesson quiz", "practice quiz for MCP", or "do I understand skills".
Забезпечення відповідності всіх комунікацій голосу та тону бренду. Використовуйте при створенні маркетингових текстів, клієнтських комунікацій, публічного контенту, або коли користувачі згадують голос бренду, тон чи стиль написання.