documentation-maintenance

Synchronizes project documentation with actual code, routes, and configuration changes.

Updated Feb 25, 2026
One-click install
npx skills add https://github.com/werlang/event-hub --skill documentation-maintenance-werlang
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-maintenance
Source: https://github.com/werlang/event-hub/tree/main/.agents/skills/documentation-maintenance
Command: npx skills add https://github.com/werlang/event-hub --skill documentation-maintenance-werlang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes often leave documentation stale, causing confusion about routes, environment variables, build commands, and conventions. This Skill keeps README, GUIDE, TESTING, AGENTS, and agent-facing files aligned with the real implementation after any code, route, config, CSS, build, Compose, or test change. ## Core Features & Use Cases - Canonical File Coverage: Maintains README.md, GUIDE.md, TESTING.md, AGENTS.md, Copilot instructions, local skill files, and reusable prompt files. - Consistency Rules: Enforces documented conventions such as admin routes under /users, frontend API calls in web/src/js/model/, mobile-first CSS with breakpoints 640/768/1024/1280/1536, and validation commands matching npm scripts. - Use Case: After adding a new API route or changing a Docker Compose command, run this Skill to verify every documentation file reflects the change and remove stale claims instead of layering caveats. ## Quick Start Review the recent route and configuration changes in this repository and update all documentation files so they match the current implementation.

Frequently Asked Questions about documentation-maintenance

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

FAQPage Schema
How do I keep project documentation in sync with code changes?▼

Verify each documentation file against the actual code before editing, then update or remove stale claims rather than adding caveats for old behavior. This Skill covers README, GUIDE, TESTING, AGENTS, Copilot instructions, and local skill files after any code, route, config, or build change.

What documentation files should be updated after an API route change?▼

Update README.md for route overviews, GUIDE.md for architecture and route ownership, and TESTING.md if validation commands change. Admin user routes must stay documented under /users, never /auth/users.

When should I run documentation maintenance?▼

Run it after changes affecting API or Web behavior, routes, response contracts, environment variables, Docker Compose, package scripts, CSS architecture, test commands, or reusable project conventions.

Does this Skill modify application source code?▼

No, it only edits documentation and agent guidance files such as README, GUIDE, TESTING, AGENTS, Copilot instructions, skill files, and prompt files. It verifies documentation against code but does not change implementation.

What CSS conventions must documentation follow in this project?▼

CSS guidance must remain mobile-first and use only the allowed breakpoints 640, 768, 1024, 1280, and 1536. Documentation describing other breakpoints or desktop-first patterns should be corrected or removed.