doc-maintenance

Review README, SPEC, and PRODUCT docs against recent git history.

71|33|Updated Mar 30, 2026
One-click install
npx skills add https://github.com/IncomeStreamSurfer/paperclip-surfers --skill doc-maintenance-incomestreamsurfer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/IncomeStreamSurfer/paperclip-surfers/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/IncomeStreamSurfer/paperclip-surfers --skill doc-maintenance-incomestreamsurfer

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the process of ensuring that top-level documentation is up-to-date with recent code changes, reducing the risk of documentation drift and improving user experience.

Core Features & Use Cases

  • Automated Documentation Review: Checks README, SPEC, and PRODUCT documentation against recent git history.
  • Feature Detection: Identifies new features, breaking changes, and structural changes in the codebase.
  • Documentation Updates: Proposes minimal edits to documentation, creates a branch, and opens a PR for review.
  • Use Case: Use this Skill after major feature merges or on a periodic schedule to maintain accurate documentation.

Quick Start

Run the 'doc-maintenance' skill to automatically update documentation for accuracy.

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 to match recent code changes in git?

To automate documentation updates, the skill reviews your git history to detect new features and breaking changes, then proposes minimal edits to your README and SPEC files. It automatically creates a branch and opens a pull request for your review.

Can I automatically check my README for accuracy against recent GitHub commits?

Yes, you can check your README for accuracy against recent GitHub commits. The skill analyzes your recent commit history to identify structural codebase changes, compares them against your top-level documentation, and flags areas where documentation drift has occurred.

What is the best way to prevent documentation drift after merging major features?

The best way to prevent documentation drift after merging major features is to run an automated review process. This skill detects newly added features in your codebase, proposes necessary documentation updates, and generates a GitHub pull request to keep your docs synchronized.

Do I need a GitHub repository to automatically generate documentation pull requests?

Yes, you need a GitHub repository to automatically generate documentation pull requests. The skill requires both git and GitHub for version control operations, specifically to create a new branch, commit the proposed documentation edits, and open a pull request for review.

What types of files does automated documentation maintenance check for accuracy?

Automated documentation maintenance checks README, SPEC, and PRODUCT documentation files for accuracy. It cross-references the content within these specific top-level files against your recent git history to identify any missing features or breaking changes that need to be documented.

When should I run automated documentation reviews for my software project?

You should run automated documentation reviews after major feature merges or on a periodic schedule. Running the review process at these specific intervals ensures your top-level documentation consistently reflects the latest structural codebase changes without accumulating manual update backlogs.