skills.rest
HeatMarie
HeatMarieCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-maintenance

Audits top-level documentation against git history and opens PRs for updates.

Updated Mar 29, 2026
Search Tags:#code review#documentation#version control#git integration#business documentation
One-click install
npx skills add https://github.com/HeatMarie/paperclip --skill doc-maintenance-heatmarie
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/HeatMarie/paperclip/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/HeatMarie/paperclip --skill doc-maintenance-heatmarie

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the review and update of business documentation, ensuring that features, capabilities, and configurations are accurately reflected, saving time and reducing manual errors.

Core Features & Use Cases

  • Automated Doc Review: Audit README, SPEC, and PRODUCT documentation against recent git history for drift.
  • Proposed Edits: Suggest minimal edits to fix inconsistencies.
  • Branch Creation & PR Opening: Automate the creation of a branch and a PR with the necessary updates.
  • Use Case: When asked to review or update documentation for accuracy after a feature merge or on a scheduled basis.

Quick Start

Run the 'doc-maintenance' skill to automatically audit and update your top-level documentation.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I automate documentation updates based on git history?▼

Automating documentation updates with git history involves auditing files like README and SPEC against recent commits. This skill identifies drift in features and configurations, proposes minimal edits, and opens a PR with the updates.

What is documentation drift and how do I detect it after a feature merge?▼

Documentation drift happens when business docs no longer match the codebase. You detect it by running an automated audit that compares README and SPEC files against recent git history to find inconsistencies in features and configurations.

Can I automatically create a pull request for README and SPEC updates?▼

Yes, you can automatically create a pull request for README and SPEC updates. The skill automates branch creation and PR opening immediately after proposing the minimal edits required to resolve documentation inconsistencies.

Does doc-maintenance work without external dependencies?▼

Yes, doc-maintenance works without external dependencies. It operates independently to audit top-level business documentation and automate git branch creation and PR opening for configuration and feature updates.

What is the best way to keep business documentation consistent with version control changes?▼

The best way to keep business documentation consistent is to run a scheduled or post-merge audit. This skill compares documentation against version control history to propose minimal edits and automate the update PR process.

Why are my feature configurations out of sync with my documentation?▼

Feature configurations fall out of sync with documentation when manual updates lag behind code merges. Running an automated audit against git history identifies this drift and proposes the necessary minimal edits to realign the docs.

Related Skills

Explore More Product & Management Skills→
kvetkvet
24

docs-check

Analyze git changes to detect documentation drift and generate a findings report.

Community
Intermediate
rishith-crishith-c
2

doc-maintenance

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

Community
Intermediate
antriksh-29antriksh-29

document-release

Update project documentation files to reflect shipped code changes.

Community
Advanced
srirajksrirajk

Git Risk Analysis

Analyze git history to produce a structured PR risk profile.

Community
Advanced