SuperAPI AI 工具集

claude-project-docs

编程与开发

查看项目

更新于 10-16 09:20

技能介绍

用途

claude-project-docs 用于为新项目设置 Claude Code,生成简洁的 CLAUDE.md 文件与智能体文档,同时也可用于审计或改进现有的 CLAUDE.md。当用户提出“为这个项目设置 Claude”“创建 CLAUDE.md”“审计/改进 CLAUDE.md”“创建智能体文档或渐进式披露结构”或“帮助 Claude 理解这个代码库”等需求时适用。

核心方法

60 行规则

CLAUDE.md 会进入每一个会话,因此应保持:理想情况下少于 60 行(HumanLayer 建议),绝对上限为 300 行,内容普遍适用,不包含任务专属内容。

WHAT/WHY/HOW 结构

文档结构包括:项目名称与一句话说明、技术栈(框架/语言、关键依赖)、项目结构(3-5 行关键目录概览)、开发(仅包含构建、测试、运行等必要命令)、关键规则(2-3 条不可协商的约束)、参考文档(指向 agent_docs/[topic].md 的按需阅读)。

渐进式披露

通过 agent_docs/ 目录存放任务专属文档,例如 building.md(构建命令、编译、打包)、testing.md(测试命令、覆盖率、测试夹具)、architecture.md(系统设计、关键决策)、database.md(模式、迁移、连接)、deployment.md(部署流程、环境)。Claude 按需读取这些文件,而非每次会话都读取。

需防止的反模式

CLAUDE.md 中绝不应包含:代码风格规则(应使用 ESLint/Prettier/linters)、完整命令文档(应放入 agent_docs/)、实现示例(应指向实际代码)、300 行的内容、来自 /init 的通用模板。原因在于 LLM 能可靠遵循约 150-200 条指令,每一条不必要的行都会降低遵循度。

工作流

  1. 生成新的 CLAUDE.md:用户请求为项目设置 Claude,技能会分析 package.json、pyproject.toml、go.mod、Makefile 等文件,生成约 60 行的最小 CLAUDE.md,并创建 agent_docs/ 结构。
  2. 审计现有 CLAUDE.md:检查行数、反模式、任务专属内容,报告发现的问题及严重程度,并建议具体的删除项与迁移至 agent_docs/ 的内容。
  3. 创建智能体文档:用户请求为测试创建智能体文档,技能会生成包含项目专属内容的 agent_docs/testing.md,并更新 CLAUDE.md 的参考部分。

输出格式

生成 CLAUDE.md 时,会展示完整文件内容,解释包含了什么以及为什么,列出有意排除的内容,并建议接下来应创建的 agent_docs/ 文件。

参考资源

references/claude-md-template.md(最小起步模板)、references/agent-docs-catalog.md(完整的 agent_docs 文件列表)、references/anti-patterns.md(详细的反模式指南)、references/examples/(按项目类型的示例)。

原则

高杠杆文档:CLAUDE.md 中的每一行都会在所有会话中消耗上下文。