doc-maintenance

Detect documentation drift across README, SPEC, and PRODUCT files.

2|Updated Mar 29, 2026
One-click install
npx skills add https://github.com/rishith-c/staple --skill doc-maintenance-rishith-c
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/rishith-c/staple/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/rishith-c/staple --skill doc-maintenance-rishith-c

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audit and align top-level documentation with evolving features to prevent drift between README, SPEC, and PRODUCT documents.

Core Features & Use Cases

  • Detect documentation drift across core docs and flag inaccuracies.
  • Propose minimal, non-destructive edits and generate a dedicated branch and PR.
  • Maintain voice and consistency while updating core docs across multiple files.

Quick Start

Run the maintenance pass to audit docs and generate a PR with drift fixes.

Frequently Asked Questions about doc-maintenance

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect documentation drift between my README and SPEC files?

Documentation drift between README.md, doc/SPEC.md, and doc/PRODUCT.md is identified by auditing core docs against evolving features and surfacing classified inaccuracies for review.

What is the best way to automatically fix outdated documentation across multiple files?

The best way to fix outdated documentation is to propose minimal, non-destructive edits that maintain voice and consistency, then generate a dedicated branch and pull request with the patches.

How do I generate a pull request for documentation updates?

You generate a pull request for documentation updates by running a maintenance pass that classifies drift, proposes patches, creates a branch, and opens a PR with a concise changelog of fixes.

Can I audit docs for drift without destructively overwriting my existing files?

Yes, you can audit docs for drift without destructive changes because the tool proposes minimal, non-destructive edits routed through a dedicated branch and pull request rather than direct commits.

When do I need to run a documentation maintenance pass?

You need to run a documentation maintenance pass when evolving features cause drift across your README, SPEC, and PRODUCT documents, requiring alignment to prevent inaccuracies.