doc-maintenance

Audit top-level project documentation against recent git history for drift.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Joaoha/xenon-maas --skill doc-maintenance-joaoha
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/Joaoha/xenon-maas/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/Joaoha/xenon-maas --skill doc-maintenance-joaoha

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audit top-level documentation (README, SPEC, PRODUCT) against recent git history to find drift — shipped features missing from docs or features listed as upcoming that already landed. Proposes minimal edits, creates a branch, and opens a PR. Use when asked to review docs for accuracy, after major feature merges, or on a periodic schedule.

Core Features & Use Cases

  • Detect drift between shipped features and documentation to ensure alignment.
  • Propose minimal edits, branch creation, and PR generation to fix drift without churn.
  • Suitable for periodic audits, post-release reviews, and governance checks across the docs suite.

Quick Start

Run the doc-maintenance skill to audit README.md, doc/SPEC.md, and doc/PRODUCT.md for drift and open a PR with minimal 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 against recent git history?

Documentation drift is detected by auditing top-level docs like README, SPEC, and PRODUCT against recent git history to find shipped features missing from docs or upcoming features that already landed. The process builds a change summary and opens a minimal-edit PR.

How do I fix outdated README files after a major release?

To fix outdated README files after major releases, run a periodic audit against recent git history to identify drift. The process generates a dedicated branch and proposes minimal edits in a pull request to ensure alignment without churn.

What is the best way to automate documentation audits for shipped features?

Automating documentation audits for shipped features involves comparing top-level docs against git history to detect drift. This approach creates a minimal-edit PR on a dedicated branch, suitable for periodic reviews and post-release governance checks.

Can I audit SPEC and PRODUCT docs alongside README in a single review?

Yes, you can audit SPEC and PRODUCT docs alongside README in a single review. The process evaluates top-level documentation against recent git history to identify drift across the entire docs suite and opens one PR with minimal fixes.

When should I run a documentation drift detection check?

You should run a documentation drift detection check when asked to review docs for accuracy, after major feature merges, or on a periodic schedule. The audit compares top-level docs against git history to find missing or outdated features.

Does documentation drift detection create a new git branch for fixes?

Yes, documentation drift detection creates a dedicated git branch for fixes. It satisfies deterministic workflow requirements by detecting changes, building a change summary, and creating a dedicated branch and PR with minimal edits.