doc-maintenance

Solid

Keep project docs aligned with recent code and feature changes — detect drift, update affected pages, and add release-relevant notes without rewriting unchanged sections.

AI & Automation 9 stars 1 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 83/100

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

Skill Content

# Doc Maintenance Keep the documentation honest with minimum churn. The goal is alignment between docs and behavior, not stylistic rewrites or cosmetic re-organization. Reviewers should be able to read a diff and see "this updates docs to match recent behavior changes". ## When to use - A PR or recent set of merges changed user-visible behavior: CLI flags, API shapes, default values, configuration keys, endpoints, environment variables, supported versions. - A user-reported bug traced back to outdated documentation. - A release is being cut and the docs need a pass against the merged commits. - A new feature shipped but only the engineer's PR description describes how to use it. ## When not to use - The change is internal-only (private helper rename, refactor) with no user-visible impact. - You want to "improve the docs" without a behavior anchor. That is a separate scoped project, not maintenance — make a plan first. ## The pass 1. **Establish the baseline.** Get the commit range you are documenting against (since last release tag, since last merged-doc commit, or since a specific PR). 2. **Enumerate user-visible changes.** Read commits and PR descriptions. List, for each change, what a user can now do differently. 3. **Map changes to docs.** For each change, find every page that mentions the affected concept. Common targets: README, CLI reference, API reference, configuration reference, migration guide, FAQ, examples. 4. **Update precisely.** Edit only the lines that...

Details

Author
getpaperclipai
Repository
getpaperclipai/paperclip
Created
3 weeks ago
Last Updated
1 weeks ago
Language
TypeScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category