documentation-management

Update project documentation files when system behavior changes.

Updated Dec 22, 2025

Search Tags:#documentation #communication #verification #readme #docs #documentation-management

Ready to run

npx skills add https://github.com/htooayelwinict/claude-config --skill documentation-management-htooayelwinict

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-management
Source: https://github.com/htooayelwinict/claude-config/tree/main/skills/documentation-management
Command: npx skills add https://github.com/htooayelwinict/claude-config --skill documentation-management-htooayelwinict

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures project documentation stays accurate when code and design change, reducing miscommunication and onboarding time.

Core Features & Use Cases

Identify documentation affected by feature changes.
Update key docs (structure, standards, and readme) to reflect current architecture and practices.
Validate that READMEs stay within prescribed length constraints.

Quick Start

Update relevant docs when a new model or pattern is introduced, then verify links and file paths.

Frequently Asked Questions about documentation-management

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

FAQPage Schema

How do I keep project documentation accurate when code changes?▼

Documentation management automatically updates key project files—architecture, standards, README, and codebase summary—when features, models, patterns, or setup change. It validates README length stays under 300 lines and cross-checks all links and file paths to prevent broken references.

What files does documentation management update?▼

It updates docs/project-overview-pdr.md, docs/codebase-summary.md, docs/code-standards.md, docs/system-architecture.md, and README.md. Each file is refreshed to reflect new features, controller changes, architectural shifts, pattern updates, and setup modifications.

When should I update documentation for code changes?▼

Update docs when introducing new features, adding models or controllers, changing design patterns, modifying system architecture, or altering setup procedures. This keeps team communication clear and reduces onboarding friction for new contributors.

Can documentation management validate README length constraints?▼

Yes, it enforces README length under 300 lines and validates that all cross-referenced links and file paths exist and point to current locations, ensuring documentation remains navigable and maintainable.

What problems does keeping docs synchronized solve?▼

Accurate, current documentation reduces miscommunication between team members, cuts onboarding time for new developers, and prevents confusion when code behavior diverges from documented intent.