doc-maintenance

Compare recent git commits with documentation to detect drift and propose minimal corrections.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps identify discrepancies and drift between documentation and the current project state, ensuring information accuracy.

Core Features & Use Cases

  • Documentation Audit: Compares documentation content against recent project changes to find outdated or inaccurate information.
  • Automated Recommendations: Suggests minimal, targeted edits to correct inconsistencies without extensive rewrites.
  • Use Case: When preparing for a major release, trigger this Skill to verify that your README, SPEC, and PRODUCT documents reflect the latest features and architecture.

Quick Start

Use the doc-maintenance skill to analyze recent changes and suggest updates for your project's documentation.

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 git commits and current project docs?

Documentation drift is detected by comparing recent git commits against current project docs. This identifies outdated information in your README or SPEC files and proposes minimal factual corrections to ensure consistency with the latest features and architecture.

What is the best way to audit project documentation for outdated features and architecture?

The best way to audit project documentation is to compare your docs content against recent project changes. This approach finds outdated or inaccurate information and suggests minimal, targeted edits to correct inconsistencies without requiring extensive rewrites.

Can I automatically generate factual corrections for my README and SPEC files?

Yes, you can automatically generate factual corrections for your README and SPEC files. The system proposes minimal, targeted edits aligned with the latest project state to correct inconsistencies without forcing you to perform extensive manual rewrites.

Do I need to prepare my git repository before running a documentation audit?

You need an accessible git repository with recent commits available for comparison. The audit relies on comparing these git changes against your current documentation materials to verify accuracy and enforce strict change detection for your project scope.

Why does my project documentation show inconsistencies after a major release?

Project documentation shows inconsistencies after a major release because of documentation drift, where recent code changes outpace manual updates. Comparing your recent git commits with current docs helps identify and propose minimal corrections for these factual gaps.