Token导航 LogoToken导航

Agent Skill · 研究检索

claude-project-docs(Claude project 文档)

用于辅助文档、README、Markdown、说明文和内容稿件的整理与改写。它适合让 Agent 提炼结构、补齐章节、统一术语、检查链接或把零散材料整理成可读文档。使用时应保留项目已有事实、命令和路径,不要把未确认的信息写成确定结论;涉及对外文案时,还需要控制语气,避免过度营销或夸大能力。

claude-project-docs 是研究检索类 Agent Skill,可用宿主为 Codex、Claude、Cursor、Gemini CLI,通过GitHub 仓库获取,权限为只读;许可证为 MIT,暂无第三方扫描结果,按安装量在研究检索类的 73,675 个 Skill 里排第 64,068。

总安装 306周安装 13GitHub Stars 公开资料未说明下载 107核验 2026-05-01

安装说明

本站只整理中文说明,不托管安装包,也不代用户安装。
GitHub
许可证
MIT

安装方式

通过对话安装

复制提示词发给支持本地命令或 Skills 的 AI 助手,先确认命令和权限,再让它执行。

请帮我安装这个 Agent Skill:claude-project-docs(Claude project 文档)
来源仓库:https://github.com/leegonzales/aiskills
仓库路径:skills/claude-project-docs
安装命令:
npx skills add leegonzales/aiskills --skill "claude-project-docs"
安装前请先检查当前环境是否支持对应 CLI,并向我确认将要执行的命令、安装目录、联网范围和文件读写权限;确认后再执行。

命令行安装

复制命令到本机终端执行。该命令会通过 npx skills 从第三方来源获取 Skill;本站只展示命令,不托管安装包,也不自动执行。

AgentSkills.tonpx skills
npx skills add leegonzales/aiskills --skill "claude-project-docs"

这个 Skill 是做什么的

研究检索类 Skill 主要解决「找资料、核对事实、把来源整理清楚」的问题,通常会让助手先检索再总结。

该技能辅助文档整理与内容改写,适用于 README、Markdown 等格式优化。可帮助提炼结构、统一术语并检查链接有效性。claude-project-docs 属于研究检索类 Skill,可作为该场景下的辅助能力补充。保留已有事实与路径信息,避免虚构未经验证的内容。对外文案需控制语气,防止夸大能力或误导性表述。

建议在关键决策点增加人工确认环节以确保准确性。

来源仓库内路径:skills/claude-project-docs

上手步骤

4 步
  1. 1

    确认自己的宿主工具

    公开资料标注支持 Codex、Claude、Cursor、Gemini CLI;先确认自己用的是其中之一,再按对应工具的 Skills 目录放置。

  2. 2

    拿到安装命令

    可以直接复制的命令是 npx skills add leegonzales/aiskills --skill "claude-project-docs";命令里的占位符换成自己的路径或密钥再执行。

  3. 3

    安装后重启宿主

    命令执行完要完全退出宿主工具再打开,让新装的 Skill 被重新扫描到,否则列表里可能看不到。

  4. 4

    按最小权限试用

    它标注为只读,先用只读任务试一次,确认行为符合预期再扩大使用范围。

常见问题

6 条

claude-project-docs 怎么安装?

在终端执行 npx skills add leegonzales/aiskills --skill "claude-project-docs"。装完完全退出宿主工具再打开,让它重新扫描本地 Skill。

claude-project-docs 支持哪些 AI 工具?

公开资料标注支持 Codex、Claude、Cursor、Gemini CLI。其他工具只要能读取本地 Skill 目录,一般也能手动放进去,但要自己确认触发方式是否一致。

claude-project-docs 需要什么权限?

权限级别是只读。该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

claude-project-docs 是免费的吗?

来源标注的许可证是 MIT。本站不代收任何费用,也不托管安装包;能否商用、要不要署名,以许可证原文为准。

claude-project-docs 用的人多吗?

公开数据是累计安装 306 次,近一周安装 13 次,下载 107 次。这些数字来自第三方目录统计,只能当作热度参考,不代表质量或安全性。

claude-project-docs 安全吗?

没有查到第三方扫描结果,安全性无法从公开资料判断,安装前请自行审查源码、依赖和命令行为。

值得选的地方和要先想清楚的地方

值得选的地方

  • 同时适配 4 种工具,换客户端不用重新找替代品。
  • 许可证明确为 MIT,商用和分发边界好判断。
  • 标注为只读权限,试用阶段不容易误改本地文件。

先想清楚的地方

  • 没有第三方扫描结果,安全性只能靠自己读源码判断。
  • 第三方目录整理,版本更新和行为细节以来源仓库为准。

适不适合你

更适合

  • 已经在用 Codex,想直接扩展它能力的人。
  • 需要处理研究检索类任务、又不想每次都手写提示词的人。
  • 只想先试试效果、不希望它改动本地文件的人。

不太适合

  • 要求有安全扫描结论才肯安装的团队。
  • 需要厂商级技术支持和 SLA 的生产系统。

研究检索类 Skill 对比

6 个同类
Skill总安装GitHub 星权限许可证扫描
find-skills

寻找技能 · Codex、Claude

31,199,81316,486操作浏览器MIT有提醒
self-improving-agent

自我改进 Agent · OpenClaw

16,464,0023,396接触敏感数据MIT-0通过
soultrace

灵魂追踪 · Codex、Claude

7,588,94412需要联网未明确有提醒
self-improving

自我完善 · OpenClaw

6,829,2841,046需要联网MIT-0通过
microsoft-foundry

微软代工厂 · Codex、Claude

6,614,144764调用外部服务未明确有提醒
claude-project-docs

Claude project 文档 · 本页

306—只读MIT未收录

按安装量取同分类前几名;数字来自第三方目录统计,只作热度参考,不代表质量结论。

SKILL.md 原文

name
claude-project-docs
description
Generate concise CLAUDE.md files and agent documentation following best practices. Use when setting up a new project for Claude Code, auditing existing CLAUDE.md, or creating progressive disclosure documentation structure.

Claude Project Docs

Create well-crafted, minimal CLAUDE.md files (~60 lines) with progressive disclosure through agent_docs/.

When to Use

Invoke when user:

  • Asks to "set up Claude for this project" or "create a CLAUDE.md"
  • Wants to "audit" or "improve" their existing CLAUDE.md
  • Needs to create agent documentation or progressive disclosure structure
  • Says "help Claude understand this codebase"

Core Methodology

The 60-Line Rule

CLAUDE.md goes into EVERY session. Keep it:

  • < 60 lines ideal (HumanLayer recommendation)
  • < 300 lines absolute maximum
  • Universally applicable - no task-specific content

WHAT/WHY/HOW Structure

# Project Name

[One sentence: what this is]

## Tech Stack
- [Framework/Language]
- [Key dependencies]

## Project Structure
[3-5 line overview of directories that matter]

## Development
[Essential commands only - build, test, run]

## Critical Rules
[2-3 non-negotiable constraints]

## Reference Documentation
When working on specific tasks, read:
- `agent_docs/[topic].md`

Progressive Disclosure

Create agent_docs/ for task-specific documentation:

FileContent
building.mdBuild commands, compilation, bundling
testing.mdTest commands, coverage, fixtures
architecture.mdSystem design, key decisions
database.mdSchema, migrations, connections
deployment.mdDeploy process, environments

Claude reads these ON DEMAND, not every session.

Anti-Patterns to Prevent

NEVER include in CLAUDE.md:

  • Code style rules (use ESLint/Prettier/linters)
  • Full command documentation (use agent_docs/)
  • Implementation examples (point to actual code)
  • > 300 lines of content
  • Generic boilerplate from /init

Why: LLMs follow ~150-200 instructions reliably. Every unnecessary line degrades compliance.

Workflow

1. Generate New CLAUDE.md

User: Set up Claude for this project
→ Analyze: package.json, pyproject.toml, go.mod, Makefile
→ Generate: Minimal CLAUDE.md (~60 lines)
→ Create: agent_docs/ structure

2. Audit Existing CLAUDE.md

User: Audit my CLAUDE.md
→ Check: Line count, anti-patterns, task-specific content
→ Report: Issues found with severity
→ Suggest: Specific removals and agent_docs/ migrations

3. Create Agent Docs

User: Create agent docs for testing
→ Generate: agent_docs/testing.md with project-specific content
→ Update: CLAUDE.md reference section

Output Format

When generating CLAUDE.md:

  1. Show the complete file content
  2. Explain what was included and why
  3. List what was intentionally excluded
  4. Suggest agent_docs/ files to create next

References

For templates and examples:

  • references/claude-md-template.md - Minimal starter template
  • references/agent-docs-catalog.md - Complete agent_docs file list
  • references/anti-patterns.md - Detailed anti-pattern guide
  • references/examples/ - Project-type examples

Principle: High leverage documentation. Every line in CLAUDE.md costs context across all sessions.

平台分布

Claude Code

30.01%
按下载量换算32

windsurf

24.1%
按下载量换算26

OpenCode

17.73%
按下载量换算19

Codex

14.15%
按下载量换算15

Antigravity

8.31%
按下载量换算9

Gemini CLI

3.79%
按下载量换算4

安全审计

暂无安全审计结果可展示。

权限和风险

只读

该 Skill 主要提供规则、说明或参考内容,本身偏只读;真正读写文件、联网或执行命令仍取决于宿主 Agent 的任务。

安装前确认

本站仅展示第三方公开信息,不托管安装包,不提供自动安装或运行环境。安装前应自行审查源码、依赖和命令行为。目前只有一个公开来源,建议同时核对源仓库。

继续浏览同类 Skills