doc-refresh

Solid

Refresh a repo's documentation for a live production system — audit stale docs, rebuild a focused doc set with diagrams, update AI-agent knowledge bases, and improve code-level docstrings

AI & Automation 113 stars 20 forks Updated 1 months ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
68
Recency 20%
75
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Documentation Refresh Skill Use this skill when asked to overhaul, refresh, modernize, or clean up a repository's documentation — especially for a system that is already in production and has accumulated stale README content, dead analysis docs, outdated AI-agent knowledge bases (`AGENTS.md`, `CLAUDE.md`, etc.), or misleading code comments. This skill is repo-agnostic. It does not assume any particular language, framework, or doc tool. It encodes a phased process, a reusable checklist, and a set of anti-patterns learned from running this refresh on real production repos. ## When to use this skill - The user says something like "our docs are out of date," "refresh the README," "clean up AGENTS.md," "audit our documentation," or "set up a docs/ folder with architecture diagrams." - A repo has legacy analysis files, dead feature references, or docs that no longer match the live code. - The user wants a repeatable framework they can reuse across repos. ## How to use this skill 1. Read `CHECKLIST.md` in this skill directory for the phase-by-phase process (Phase 0 through Phase 6). 2. Read `ANTI-PATTERNS.md` for common mistakes to avoid while auditing and rewriting docs. 3. Adapt the checklist to the target repo: - Confirm with the user which phases apply (a small repo may not need every phase; a large one may want each phase in its own session to protect context windows). - Identify the repo's actual doc tooling (Markdown + Mermaid is the d...

Details

Author
robertguss
Repository
robertguss/claude-code-toolkit
Created
8 months ago
Last Updated
1 months ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category