maintain-docs

Automate documentation maintenance with progressive disclosure and Python scripts.

Updated Aug 23, 2026

Search Tags:#automation #documentation #pre-commit #progressive-disclosure #AGENTS.md #table-updates #reference-docs

Ready to run

npx skills add https://github.com/Oxilith/CopilotSkills --skill maintain-docs-oxilith

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: maintain-docs
Source: https://github.com/Oxilith/CopilotSkills/tree/main/.agentskills/skills/maintain-docs
Command: npx skills add https://github.com/Oxilith/CopilotSkills --skill maintain-docs-oxilith

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

The Maintain Docs skill automates documentation management for code changes using a progressive disclosure framework, helping teams keep a stable main guide while evolving detailed reference material.

Core Features & Use Cases

Progressive disclosure framework: maintains a stable main documentation file (AGENTS.md) and a set of evolving reference docs.
Pre-commit documentation checks: guides agents to assess whether changes belong in the main doc or a reference doc, and to create/update docs accordingly.
Automated reference doc lifecycle: creates new reference docs from a template, and updates the Reference Documentation table to keep mappings current.

Quick Start

Review the skill purpose and structure.
Run assess_doc_change.py "<description of change>" to determine where documentation should go.
If a new reference doc is needed, run python scripts/create_reference_doc.py <topic> "<when-to-read>" to generate it.
Update the Reference Documentation table with python scripts/update_reference_table.py <filename> "<when-to-read>".
Run npm run lint to validate documentation and tooling setup.

Frequently Asked Questions about maintain-docs

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

FAQPage Schema

How do I automate documentation updates for code changes using pre-commit checks?▼

You can automate documentation maintenance by running Python scripts like assess_doc_change.py to evaluate code changes during pre-commit checks and route updates to reference docs, keeping the main guide stable.

What is a progressive disclosure framework for repository documentation?▼

A progressive disclosure framework separates documentation into a stable main guide, such as AGENTS.md, and a set of evolving per-topic reference docs. This structure prevents main guides from bloating while detailed references grow independently.

How do I create a new reference doc and update the documentation table?▼

Run create_reference_doc.py with the topic and when-to-read parameters to generate the doc from a template, then execute update_reference_table.py to register the new file in the Reference Documentation table and keep mappings current.

Does this documentation maintenance workflow require any external dependencies?▼

No external dependencies are required, but the workflow needs Python tooling to run the assessment, creation, and table update scripts, plus npm to run lint validation for checking the documentation and tooling setup.

When should I move documentation details into a separate reference doc?▼

You should move details into a separate reference doc when assess_doc_change.py determines the change does not belong in the main AGENTS.md file, ensuring the primary guide remains stable while reference material evolves.