doc-maintenance

Analyze recent code changes to detect documentation inconsistencies across README, SPEC, and PRODUCT files.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the detection and correction of documentation drift in project files, ensuring that user-facing documents remain current and reliable.

Core Features & Use Cases

  • Automated Documentation Audit: Compares recent code changes against documentation to identify discrepancies.
  • Minimal Edits & PR Creation: Proposes small, targeted fixes and automatically opens pull requests for review.
  • Use Case: When a new feature is merged, use this Skill to verify that the documentation reflects the update and request corrections if necessary.

Quick Start

Run the doc-maintenance skill on your repository to detect drift, propose fixes, and generate a pull request for review.

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 audits to find inconsistencies after code changes?

Automated documentation audits compare recent code changes against project files to detect drift. This skill analyzes updates alongside README, SPEC, and PRODUCT files to identify technical discrepancies and ensure alignment.

Can I automatically create a pull request for documentation fixes on GitHub?

You can automatically create a pull request for documentation fixes on GitHub. This skill proposes minimal, targeted edits to correct discrepancies and opens a PR for review, ensuring safe document integrity.

What is documentation drift and how do I detect it in project files?

Documentation drift occurs when user-facing documents become outdated relative to implementation. You detect it by comparing recent code changes against key project files like README and SPEC to identify technical inaccuracies.

How do I ensure minimal edits and maintain document integrity during a CI audit?

To ensure minimal edits during a CI audit, this skill proposes small, targeted fixes rather than large rewrites. It safely patches discrepancies to maintain document integrity while aligning implementation with user-facing docs.

Does this automated documentation audit work with SPEC and PRODUCT files?

Yes, the automated documentation audit works across multiple key project documents including SPEC and PRODUCT files. It analyzes these files to identify inconsistencies with recent code changes and proposes targeted corrections.