update-doc

Solid

Keep repository documentation synchronized with the latest code. Use when updating README/docs/codemaps after code changes, running docs-drift checks, or producing scoped evidence-backed doc patches for service/library/CLI/monorepo projects.

AI & Automation 27 stars 5 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 85/100

Stars 20%
48
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Update Docs Synchronize documentation with repository evidence and avoid stale or speculative content. ## Quick Reference | If you need to… | Go to | |---|---| | Update README/docs after a code change (default workflow) | §Pre-Update Gates → §Diff Scope Gate → §Workflow | | Choose the right doc structure for project type (service / library / CLI / monorepo) | §Project Type Routing + Load `references/project-routing.md` | | Check docs-drift: find gaps between code and docs | §Quality Scorecard (12 Checks) + Load `references/update-doc.md` | | Add CI checks to catch docs drift automatically | Load `references/ci-drift.md` | | Know what language/audience to write for | §Audience and Language Gate | | Understand what to mark vs. invent (`Not found in repo`) | §Hard Rules | | Get the final scorecard and output format | §Quality Scorecard (12 Checks) + §Output Format | ## Hard Rules - Use repository files as the only source of truth. - Mark missing information as `Not found in repo`. - Do not invent APIs, routes, env vars, ports, jobs, or dependencies. - Prefer minimal patches by default; preserve existing doc structure unless user requests restructure. - Use diff-scoped updates first; avoid unrelated bulk rewrites. - Keep output scannable: headings + concise bullets + short runnable command blocks. - Keep internal workflow markers out of user-facing docs by default. Verification labels, scorecards, and evidence tables belong in the assistant response unless the user explici...

Details

Author
johnqtcg
Repository
johnqtcg/awesome-skills
Created
4 months ago
Last Updated
yesterday
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category