Detect documentation drift and generate minimal factual edits via pull requests.
npx skills add https://github.com/khoabd/paperclip --skill doc-maintenance-khoabd
Please help me install this Agent Skill. Skill: doc-maintenance Source: https://github.com/khoabd/paperclip/tree/main/.agents/skills/doc-maintenance Command: npx skills add https://github.com/khoabd/paperclip --skill doc-maintenance-khoabd
This Skill eliminates the risk of outdated, inaccurate top-level product documentation that misleads users about current software capabilities, saving teams hours of manual cross-referencing between code changes and docs.
Ask the AI to run the doc-maintenance skill to audit and fix inaccuracies in your project's top-level README, SPEC, and PRODUCT documentation after a recent feature release.
High-intent search queries and answers about installing and using this skill.
Documentation drift is detected by scanning recent non-merge git commits to identify shipped features and breaking changes missing from top-level markdown files. This process cross-references code updates against README, SPEC, and PRODUCT documents to find missing or outdated information.
To update a README after merging a feature, an automated workflow scans the git history, applies minimal factual edits to preserve document voice, and opens a pull request with a detailed change summary for team review.
Yes, automated documentation fixes apply only minimal factual edits to correct inaccuracies. This approach intentionally preserves the existing document tone, structure, and voice without applying unnecessary rewrites or cosmetic changes.
The best way to audit markdown documentation is running a scheduled or post-merge review process that cross-references recent code changes with top-level docs. It identifies outdated feature descriptions and generates a pull request with factual corrections.
Yes, you need to manually review documentation updates because the process creates a dedicated branch, commits fixes, and opens a pull request with a detailed change summary for team review before merging into the main project.
You should run a documentation accuracy check on SPEC and PRODUCT markdown files during periodic scheduled audits or immediately after post-major-feature-merge reviews to ensure top-level user-facing documentation reflects current software capabilities.
louisfbuysScan top-level documentation for drift against git history and open PRs.
mthinesGenerate structured pull request descriptions from commit history and diff stats.
mrkhachaturovAudit Markdown files against code changes and update factual content.
bacchus-labsReview documentation pull requests against issue requirements and code accuracy.
