AgentSkillsCN

documentation-management

在行为发生变化时保持项目文档准确。仅限 project-manager agent 使用。

SKILL.md
--- frontmatter
name: documentation-management
description: Keep project documentation accurate when behavior changes. EXCLUSIVE to project-manager agent.
allowed-tools: Read, Edit, Write, Grep, mcp_codex-bridge, mcp_gemini-bridge, mcp_context7, mcp_playwright, mcp_zread, mcp_web-search-prime, mcp_web-reader, mcp_zai-mcp-server, mcp_open-bridge

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)

code
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"