documentation-management

htooayelwinict's avatarfrom htooayelwinict

Keep project documentation accurate when behavior changes. EXCLUSIVE to project-manager agent.

⭐0stars🔀0forks📁View on GitHub🕐Updated Dec 22, 2025
[Project Management]

When & Why to Use This Skill

This Claude skill automates the maintenance of project documentation, ensuring that README files, architecture designs, and codebase summaries remain accurate as the project evolves. It helps project managers and developers avoid 'documentation rot' by automatically updating relevant files whenever features, models, or system architectures change, maintaining a reliable 'Source of Truth' for the entire team.

Use Cases

  • Case 1: Automatically updating project-overview-pdr.md and codebase-summary.md immediately after a new feature or data model is implemented.
  • Case 2: Enforcing documentation quality standards by keeping the root README.md concise (under 300 lines) and validating that all internal links and file paths are functional.
  • Case 3: Synchronizing system-architecture.md and code-standards.md whenever there is a shift in design patterns or infrastructure to ensure technical debt is documented.
  • Case 4: Cross-referencing documentation across multiple files to ensure no contradictions exist after significant codebase refactoring.
namedocumentation-management
descriptionKeep project documentation accurate when behavior changes. EXCLUSIVE to project-manager agent.
allowed-toolsRead, Edit, Write, Grep

Documentation Management

Exclusive to: project-manager agent

Instructions

  1. Identify what changed affecting docs
  2. Update appropriate file(s) based on change type
  3. Keep content concise and actionable
  4. Verify README under 300 lines
  5. Cross-check links and file paths

Documentation Structure (Source of Truth)

docs/
├── project-overview-pdr.md   # Goals, features, requirements
├── codebase-summary.md       # Structure, models, routes, components
├── code-standards.md         # Conventions and patterns
└── system-architecture.md    # Design and data flow

Also: README.md (root) — Keep under 300 lines

Update Triggers

Change Type Update
New feature project-overview-pdr.md, codebase-summary.md
New model/controller codebase-summary.md
Pattern change code-standards.md
Architecture change system-architecture.md
Setup change README.md

Update Process

  1. Identify what changed affecting docs
  2. Update appropriate file(s)
  3. Keep content concise and actionable
  4. Verify README under 300 lines

Cross-Reference Validation

After updates, verify:

  • Links still work
  • File paths accurate
  • Code examples current
  • No contradictions between docs

README Constraints

Section Max Lines
Quick Start 30
Documentation links 20
Tech Stack 15
Commands 20
Total < 300

Examples

  • "Update docs after adding a new model"
  • "Document a new design pattern"