Back to list
mgkyawzayya

documentation-management

by mgkyawzayya

1🍴 0📅 Dec 16, 2025

SKILL.md


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 TypeUpdate
New featureproject-overview-pdr.md, codebase-summary.md
New model/controllercodebase-summary.md
Pattern changecode-standards.md
Architecture changesystem-architecture.md
Setup changeREADME.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

SectionMax Lines
Quick Start30
Documentation links20
Tech Stack15
Commands20
Total< 300

Examples

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

Score

Total Score

50/100

Based on repository quality metrics

SKILL.md

SKILL.mdファイルが含まれている

+20
LICENSE

ライセンスが設定されている

0/10
説明文

100文字以上の説明がある

0/10
人気

GitHub Stars 100以上

0/15
最近の活動

3ヶ月以内に更新がある

0/10
フォーク

10回以上フォークされている

0/5
Issue管理

オープンIssueが50未満

+5
言語

プログラミング言語が設定されている

+5
タグ

1つ以上のタグが設定されている

0/5

Reviews

💬

Reviews coming soon