agentleFS
x0cx0c/doc-skills/doc-compact/SKILL.md

doc-compact

Skill2 starsChanged 50 days agoMITView on GitHub

Audit and compress bloated project documentation while preserving behavior and repairing navigation. Use for redundant docs, broken indexes, oversized AGENTS.md, malformed CLAUDE.md, or missing global documentation governance.

1 other project uses a version of this.

Adopted by

Most recently taken up by

  • Other versions1 project uses a version of this.

    Word for word · 1

    1. x0c/agent-doc-skills★ 2100% same

    Edited · 0

    None found.

    Wrote their own version · 0

    None found.

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository4 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 3 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Read-only audit: run python3 scripts/audit.py PROJECT_ROOT and inspect actual coverage, misplaced/repeated content and relevant authority.

    line 12
  2. Distinctive:

    Whole-project cleanup: read maintenance workflow.

    line 14
  3. Distinctive:

    Read compression guide before substantive compression.

    line 20
  4. Distinctive:

    After accepted changes pass the scoped checks, close out rather than starting another harvest or wording pass.

    line 26

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Documentation compaction

Audit and compress documentation while preserving adopted behavior, evidence and discoverability. Follow the installed lifecycle and environment policies; use agents-md-edit for AGENTS.md edits. Delegate only under current user authorization.

Choose the work

  • Read-only audit: run python3 scripts/audit.py PROJECT_ROOT and inspect actual coverage, misplaced/repeated content and relevant authority. Use the audit sections of maintenance workflow. Do not install presets, stamp or repair files.
  • Bounded cleanup: inspect the affected domain and overlapping references, then use the relevant structure/compression/verification sections of that workflow. Do not expand a small request into a repository census.
  • Whole-project cleanup: read maintenance workflow. Discover effective global instructions, audit each actual documentation host, decide structure by readability, compress content and verify the full requested scope.

Preservation and verification

Change generated or inherited rules through their actual source; preserve managed markers and valid coverage. Use concise content summaries with the shared relevance instruction, without arbitrary reading quotas. Compression does not drop scope, exceptions, timing, evidence or machine-parsed literals.

Read compression guide before substantive compression. Distinguish a smaller file from preserved behavior. Check navigation, source/path liveness, ordinary and exceptional scenarios, and required compact-stamp coverage. Report per-domain results and unresolved factual contradictions; a successful script or stamp is limited coverage evidence.

Migration completion and stop rule

An authorized knowledge migration is complete when the shared authority preserves the reusable knowledge's applicability and exceptions, local product contracts and evidence remain intact, generic duplication is replaced where safe, and content rereading plus navigation checks reveal no unresolved material defect. For multi-file work, reuse one concise source → authority → local retention/outcome table when useful; a small edit needs no extra ledger.

After accepted changes pass the scoped checks, close out rather than starting another harvest or wording pass. Reopen for a concrete defect, contradiction, missed authorized item, or new user direction. Additional reviews need a specific unresolved question; optional polish alone does not require another cycle.

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.