doc-maintenance

Name: doc-maintenance
Availability: InStock
Author: tamzi

Audit top-level documentation against recent git history and open pull requests.

Updated Mar 10, 2026

Search Tags:#git #github #doc maintenance #codebase sync #automated update

Ready to run

npx skills add https://github.com/tamzi/theorg --skill doc-maintenance-tamzi

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/tamzi/theorg/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/tamzi/theorg --skill doc-maintenance-tamzi

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures your documentation remains accurate by auditing and updating it automatically based on recent changes in your codebase.

Core Features & Use Cases

Automated Documentation Audit: Checks top-level documentation for drift against recent git history.
Proposed Edits: Suggests minimal edits to fix any discrepancies.
Branch & PR Creation: Automatically creates a branch and opens a pull request with the proposed changes.
Use Case: Ideal for regular doc reviews, after major feature merges, or on a periodic schedule to keep your documentation in sync with your codebase.

Quick Start

Run the skill to update your documentation by executing 'paperclip doc-maintenance'.

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 my codebase?▼

Automating documentation updates involves comparing top-level files like README and SPEC against recent git history to propose minimal edits and open a pull request with the synced changes.

What is documentation drift and how do I detect it in GitHub?▼

Documentation drift occurs when guides become outdated compared to code. You can detect it by comparing top-level documents against recent git history to identify and propose minimal edits for discrepancies.

Do I need git knowledge to keep my README in sync with my code?▼

Yes, synchronizing your README requires git and GitHub knowledge. The process uses git history to audit documents and automatically creates branches and pull requests for proposed updates.

Can I automatically create a pull request for codebase sync updates?▼

Yes, you can automatically create a pull request for codebase sync updates. The workflow creates a branch with proposed documentation edits and opens a PR directly on GitHub.

When should I run automated documentation maintenance?▼

You should run automated documentation maintenance during regular reviews, after major feature merges, or on a periodic schedule to keep your guides accurately synced with your codebase.

What's the best way to maintain top-level SPEC and PRODUCT guides?▼

The best way to maintain SPEC and PRODUCT guides is by auditing them against recent git history. This approach suggests minimal edits and opens pull requests to resolve any detected discrepancies.