agentleFS
TashanGKDTashanGKD/cc_plugins/.claude/skills/docs/SKILL.md

docs

Skill4 starsChanged 10 months agoMITView on GitHub

活文档维护。智能分析项目代码,维护 docs/ 核心文档和 README.md,包含健康检查、自动更新、质量评分功能。用户提到更新文档、同步文档时使用。

165 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use import-memory, perf and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • amirbironSkill

    import-memory

    Import a memory export from another AI assistant into Claude's memory — conversationally, additively, and with the content treated as data.

    Also in 3 projects that use this

  • MicrosoftSkill

    perf

    Speed and memory performance rules for Rust crates, the Node addon, webui-framework, and webui-delivery.

    Also in 4 projects that use this

  • diego-tobalinaSkill

    build-fix

    Fix build and compilation errors systematically. Run when build fails.

    Also in 3 projects that use this

  • JkudjoSkill

    incident

    Production incident response — structured triage, hypothesis tree, safe remediation, incident record

    Also in 4 projects that use this

  • vbrevikSkill

    work

    Use when the user says 'plan', 'todo', 'copy plan', 'append plan', 'resume plan', 'priorities', or 'what's next'.

    Also in 7 projects that use this

  • mbwsimsSkill

    impact

    This skill should be used when the user asks to "check the impact", "what will break if I change this", "blast radius", "impact analysis", "what depends on this", "who imports this", "is it safe to change this", mentions "/impact", or wants to understand the consequences of modifying a specific file or function before making changes.

    Also in 3 projects that use this

The file

Files
SKILL.md

/docs - 活文档维护

代码即真相,文档跟随代码

智能分析项目代码,维护 docs/ 核心文档和 README.md


用法

/docs                 # 健康检查(默认)
/docs file            # 更新指定文件
/docs init            # 初始化文档骨架
/docs score           # 质量评分

1. 健康检查

执行 /docs 显示文档健康状态:

📊 文档健康状态

| 文档 | 状态 | 最后更新 | 相关代码变更 |
|------|------|----------|-------------|
| CLAUDE.md | ✅ 新鲜 | 今天 09:30 | 无 |
| README.md | ✅ 新鲜 | 2天前 | 无 |
| docs/architecture.md | ⚠️ 过时 | 今天 14:30 | src/auth.py 新增 OAuth |

2. 初始化文档骨架

/docs init

自动创建:

docs/
├── architecture.md     # 架构设计
├── components.md       # 组件清单
├── development.md      # 开发指南
├── testing.md          # 测试策略
└── contributing.md     # 贡献指南

3. 智能更新

代码变更自动更新
新增模块components.md
修改导入关系architecture.md
修改配置文件development.md
新增测试testing.md
/docs                        # 更新所有过时文档
/docs docs/architecture.md   # 更新指定文档
/docs --preview              # 预览变更

4. 质量评分

/docs score

输出:

📊 文档质量评分

| 维度 | 得分 | 目标 | 状态 |
|------|------|------|------|
| 覆盖度 | 75% | ≥80% | ⚠️ |
| 新鲜度 | 60% | ≥70% | ❌ |
| 完整性 | 85% | ≥80% | ✅ |

总体评分: C+ (79.5/100)

5. 核心文档清单

文件维护方式内容
CLAUDE.md/init项目指令、工作流
README.md/docs项目概述、安装
docs/architecture.md/docs系统架构、模块关系
docs/components.md/docs组件清单、职责边界

6. Git 提交规范

场景前缀示例
更新核心文档docs:docs: 更新架构文档
更新项目指令chore:chore: 更新 CLAUDE.md

文档过时 = 项目失活

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.