skills.rest
triss-smith
triss-smithCOMMUNITY
Explore all skills by this author →
GitHub

doc-maintenance

Audit documentation against recent commits and open a PR with fixes.

Updated Apr 14, 2026
Search Tags:#automation#git#documentation#audit#drift#pull-request
One-click install
npx skills add https://github.com/triss-smith/offwatch --skill doc-maintenance-triss-smith
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/triss-smith/offwatch/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/triss-smith/offwatch --skill doc-maintenance-triss-smith

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Audit top-level documentation against recent git history to identify drift and propose minimal edits via automated branch and PR workflow.

Core Features & Use Cases

  • Detect drift between README, SPEC, and PRODUCT docs and surface necessary updates.
  • Generate a minimal patch set and a PR-ready summary for governance and review.
  • Use on a periodic schedule or after major releases to keep docs in sync.

Quick Start

Run the doc-maintenance skill to audit docs against recent commits and propose PR-ready edits.

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 recent git commits?▼

You can detect documentation drift by auditing README.md, SPEC.md, and PRODUCT.md against recent git history to surface inaccuracies. This process identifies outdated content and generates minimal, PR-friendly edits to fix the discrepancies automatically.

Can I automatically generate a pull request to fix outdated documentation?▼

Yes, you can automatically generate a pull request to fix outdated documentation. The workflow creates a dedicated branch, applies minimal edits to correct drift, and opens a pull request containing a concise changelog for governance review.

What is the best way to keep project docs in sync after a major release?▼

The best way to keep project docs in sync after a major release is running a scheduled documentation audit. Comparing top-level files against recent commits identifies necessary updates and proposes a minimal patch set via an automated branch and PR workflow.

Does this documentation audit require any external dependencies or tools?▼

No, this documentation audit requires no external dependencies or tools to function. It operates independently to compare your project documents against git history and generate pull requests without needing additional packages installed.

How do I use an audit checklist to scope documentation updates?▼

Use an audit checklist to scope documentation updates by referencing structured guidelines during the drift comparison. This ensures the reporting covers necessary sections and applies minimal, targeted edits rather than broad, unnecessary rewrites.

Related Skills

Explore More Content & Communication Skills→
priyansh19priyansh19
1

doc-maintenance

Audit documentation against recent git history and open a PR with minimal edits.

Community
Advanced
ibalasiteibalasite

ship

Merge a feature branch, run tests, bump VERSION, update CHANGELOG, and create a pull request.

Community
Advanced
sobhanashinesobhanashine
1

ship

Automate software deployment by merging branches, running tests, and updating versioning.

Community
Advanced
luiztrilhaluiztrilha

dunderia-doc-maintenance

Audit MaestrIA documentation against recent code commits and apply corrections.

Community
Intermediate