Menú
按照 AI 代理接入最佳实践创建或更新 CLAUDE.md 文件
Instalar con Codex o Claude Copia este prompt, pégalo en Codex, Claude u otro asistente, y deja que revise la página de la skill y la instale por ti.
Basado en la clasificación ocupacional SOC
从想法和资源出发起草博客文章。当用户想要写博客文章、从研究中创建内容或草拟文章时使用。引导完成研究、头脑风暴、大纲制定和带版本控制的迭代式写作流程。
确保所有沟通内容符合品牌语调和风格指南。在创建营销文案、客户沟通、面向公众的内容时使用,或当用户提及品牌语调、语气或写作风格时触发。
全面代码审查,涵盖安全性、性能和质量分析。当用户要求审查代码、分析代码质量、评估 Pull Request 或提及代码审查、安全分析、性能优化时使用。
从源代码生成全面、准确的 API 文档。用于创建或更新 API 文档、生成 OpenAPI 规范,或当用户提及 API 文档、接口端点、文档时使用。
基于 Martin Fowler 方法论的系统化代码重构。当用户要求重构代码、改善代码结构、减少技术债务、清理遗留代码、消除代码异味或提升可维护性时使用。本技能引导完成研究、规划和安全增量实现的分阶段流程。
Claude Code 教程交互式课时测验。通过 8-10 道混合概念和实践知识的问题测试对特定课程(01-10)的理解。可在课前用于预测试、课中用于进度检查或课后用于验证掌握程度。当用户说"quiz me on hooks"(给我出道钩子的测验)、"test my knowledge of lesson 3"(测试我对第3课的知识)、"lesson quiz"(课时测验)、"practice quiz for MCP"(MCP 练习测验)或 "do I understand skills"(我理解技能了吗)时使用。
| name | claude-md |
| description | 按照 AI 代理接入最佳实践创建或更新 CLAUDE.md 文件 |
$ARGUMENTS
你必须先考虑用户输入再继续(如果不为空)。用户可以指定:
create -- 从零创建新的 CLAUDE.mdupdate -- 改进已有 CLAUDE.mdaudit -- 分析并报告当前 CLAUDE.md 的质量src/api/CLAUDE.md 用于目录级指令)LLM 是无状态的:CLAUDE.md 是唯一在每个会话中自动加载的文件。它是 AI 代理接入你的代码库时的主要引导文档。
少即是多:前沿 LLM 可以遵循约 150-200 条指令。Claude Code 的系统提示词本身已占用约 50 条。保持你的 CLAUDE.md 聚焦且精简。
普适性原则:只包含与每次会话都相关的信息。任务特定的指令应放在单独的文件中。
不要把 Claude 当作 Linter:风格规则会增加上下文负担并降低指令遵循度。应使用确定性工具(prettier、eslint 等)代替。
永远不要自动生成:CLAUDE.md 是 AI 工具链中杠杆效应最高的地方。需经过深思熟虑手动精心编写。
首先,分析当前项目状态:
检查是否已存在 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/` -- 共享库
## 开发命令
- 安装:`命令`
- 测试:`命令`
- 构建:`命令`
## 关键约定
[仅限非显而易见的高影响约定]
- 约定 1 及简要说明
- 约定 2 及简要说明
## 已知问题 / 常见坑
[容易让开发者踩坑的事项]
- 问题 1
- 问题 2
不要包含:
最终确定前,验证:
create 或默认模式:update:audit:如果用户请求创建/更新 AGENTS.md:
AGENTS.md 用于定义专用代理的行为。与 CLAUDE.md(用于项目上下文)不同,AGENTS.md 定义:
应用相似的原则: