Skip to content
cccskills
FreePublished on GitHub

tidy-docs

Mechanical documentation hygiene. Spawns a doc-maintainer agent to audit all project documentation and fix correctness, completeness, freshness, and consistency issues autonomously within its authority. Surfaces anything requiring user judgment for approval.

The English summary is being prepared. Showing the original description.

See how to install

Files included (2)

  • SKILL.md1.8 KB
  • references/README.md4.3 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

Tidy-Docs - Documentation Hygiene

Spawns a doc-maintainer agent to comprehensively audit all project documentation and fix the issues it finds. The find→fix seam is small — typos, stale code examples, broken links, freshness drift — so the skill runs as a tidy rather than a review.

Workflow

1. Spawn doc-maintainer agent

Spawn a DOC - Maintainer agent with the following prompt:

Perform a comprehensive review of ALL project documentation. This is a
standalone audit — do NOT scope to git diff. Instead, review every
documentation file in the project.

Steps:
1. Discover all documentation files (README.md, CLAUDE.md, CONTRIBUTING.md,
   CHANGELOG.md, doc/, docs/, adr/, and any other .md files)
2. Review each for correctness, completeness, and freshness using your
   full quality checklist (code-documentation consistency, completeness,
   link validation, style consistency, freshness)
3. Fix issues you find autonomously (within your authority)
4. Report what you changed and any issues requiring user approval

If no documentation issues are found, report that and exit.

2. Report results

After the agent completes, present its findings to the user:

  • What was reviewed
  • What was changed (if anything)
  • Issues requiring user approval (if any)

3. Commit (optional)

If changes were made, ask the user if they want to commit. If yes:

git add [specific files]
git commit -m "$(cat <<'EOF'
docs: tidy project documentation

[Brief description of changes made]
EOF
)"

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

Bug-fixing workflow that coordinates diagnosis, test-driven reproduction, root-cause analysis, and targeted fixes. Use when the user wants to fix a bug with thorough investigation and regression testing.

The English summary is being prepared. Showing the original description.

chrisallenlane/claude-swe-workflows18Updated May 19, 2026

Proactive bug-hunting workflow. Assesses codebase risk through complexity, coverage, and structural analysis, then spawns focused investigators that write reproducing tests to validate suspected bugs. Thoroughness over speed. Advisory only — produces findings and proposes tickets; does not implement fixes.

The English summary is being prepared. Showing the original description.

chrisallenlane/claude-swe-workflows18Updated May 19, 2026

Iterative development workflow that coordinates implementation, refactoring, QA, and documentation agents to complete features systematically. Use when the user wants a full development workflow with quality checks.

The English summary is being prepared. Showing the original description.

chrisallenlane/claude-swe-workflows18Updated May 19, 2026

Multi-ticket batch workflow. Takes a batch of tickets, plans execution order, implements each via /implement in autonomous mode, runs cross-cutting quality passes, and presents results for final review.

The English summary is being prepared. Showing the original description.

chrisallenlane/claude-swe-workflows18Updated May 19, 2026

Full-lifecycle project workflow. Takes batched tickets, implements via /implement-batch, runs smoke tests, then executes a comprehensive quality pipeline (refactor, review-arch, review-test, tidy-docs, review-release). Maximizes autonomy with andon cord escape.

The English summary is being prepared. Showing the original description.

chrisallenlane/claude-swe-workflows18Updated May 19, 2026

Autonomous bug-elimination loop. Iteratively invokes /bug-hunt and /implement-batch until findings converge below an operator-specified severity floor. At termination, runs /review-test scoped to the run's new reproducing tests and fixes quality issues above the floor. Auto-approves /bug-hunt and /review-test ticket proposals; pulls the andon cord on contested findings, repeated implementation failure, hard-cap exhaustion, or breaking-change proposals. Optional /refactor finisher.

The English summary is being prepared. Showing the original description.

chrisallenlane/claude-swe-workflows18Updated May 19, 2026

See all skills by chrisallenlane

Report a problem with this skill