doc-maintenance

Audit README, SPEC, and PRODUCT docs for drift and open a PR.

Updated Apr 16, 2026
One-click install
npx skills add https://github.com/travelinman1013/royclip --skill doc-maintenance-travelinman1013
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/travelinman1013/royclip/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/travelinman1013/royclip --skill doc-maintenance-travelinman1013

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audits the top-level project documentation to identify drift between shipped features and what is described, enabling timely corrections.

Core Features & Use Cases

  • Detect documentation drift relative to recent commits and releases.
  • Propose minimal, factual edits and orchestrate a branch + PR workflow.
  • Validate against a structured audit checklist to ensure coverage of README, SPEC, and PRODUCT docs.

Quick Start

Run the doc-maintenance workflow to audit README.md, doc/SPEC.md, and doc/PRODUCT.md for drift and propose minimal edits via a new branch and PR.

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 after a major release?

To detect documentation drift after a major release, audit top-level project files like README.md and doc/SPEC.md against recent commits. This identifies gaps between shipped features and documented specs, enabling timely corrections through minimal, fact-based edits.

What is the best way to automate a documentation audit using a pull-request workflow?

Automating a documentation audit using a pull-request workflow involves validating files against a structured checklist and orchestrating a branch + PR workflow. This enforces minimal, fact-based edits guided by an audit checklist and opens a PR with a concise change summary.

Can I audit SPEC and PRODUCT docs for drift during change-dense periods?

Yes, you can audit SPEC and PRODUCT docs for drift during change-dense periods. Applying the audit workflow to top-level documentation during these cycles validates coverage against a structured checklist and proposes necessary factual corrections.

Does the doc-maintenance workflow require external dependencies to run?

No, the doc-maintenance workflow requires no external dependencies to run. It operates independently to audit project documentation, identify drift between shipped features and descriptions, and orchestrate a branch and PR workflow for corrections.

When should I not use an automated branch-and-PR workflow for documentation updates?

You should avoid an automated branch-and-PR workflow for documentation updates when changes are not fact-based or minimal. The workflow enforces a structured audit checklist for README, SPEC, and PRODUCT docs, making it unsuitable for unstructured or large-scale rewrites.