home / skills / htooayelwinict / claude-config / documentation-management

documentation-management skill

safe

This skill keeps project documentation accurate when behavior changes by updating files, validating links, and maintaining concise, actionable content.

npx playbooks add skill htooayelwinict/claude-config --skill documentation-management

Review the files below or copy the command above to add this skill to your agents.

Files (2)

SKILL.md

1.7 KB

---
name: documentation-management
description: Keep project documentation accurate when behavior changes. EXCLUSIVE to project-manager agent.
allowed-tools: Read, 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"

Overview

This skill keeps project documentation accurate and actionable whenever code or design changes. It is exclusive to the project-manager agent and enforces a clear source-of-truth structure, update triggers, and README constraints. The goal is concise docs that reflect current behavior and reduce onboarding friction.

How this skill works

The skill inspects change metadata and maps each change to the specific doc files that must be updated (project overview, codebase summary, code standards, system architecture, or README). It applies a short update workflow: identify change impact, update targeted files with concise edits, and run cross-reference validation for links, paths, and examples. It verifies README line limits and flags contradictions or outdated code snippets.

When to use it

After merging a new feature or scope change
When adding or modifying models, controllers, or APIs
If coding patterns or conventions are updated
When architecture or data flow changes are introduced
When setup, scripts, or developer commands change

Best practices

Edit only the files mapped to the change type to avoid unnecessary churn
Keep entries concise, actionable, and focused on developer needs
Limit README sections to specified line counts and keep total under 300 lines
Update code examples and verify they run or reflect real usage
Cross-check links and file paths after every documentation update

Example use cases

Add short summaries in project-overview-pdr.md and codebase-summary.md after introducing a new feature
Document a newly created model and controller in codebase-summary.md with fields and relationships
Adjust code-standards.md when adopting a new error-handling or naming pattern
Revise system-architecture.md when introducing a new service or changing data flow
Update README.md setup and commands when build or deployment steps change

FAQ

Which file should I update for a new API endpoint?

Update codebase-summary.md with the new route, controller, and data shapes; update project-overview-pdr.md if the endpoint changes user-facing behavior.

What if a change touches multiple areas?

Apply focused edits to each affected file per the update triggers and keep each section concise. Run cross-reference validation to ensure consistency.