AgentSkillsCN

noodlbox-generating-documentation

生成架构文档、绘制代码库地图、详尽记录代码结构。创建 ARCHITECTURE.md 文件，生成 Mermaid 图表，为各模块与流程添加清晰标注，并撰写 README 文件以全面阐释代码库的组织架构。本技能不适用于代码探索（请使用 exploring-codebases）或变更规划（请使用 change-planning）。

SKILL.md
--- frontmatter
name: noodlbox-generating-documentation
description: >-
  Generate architecture documentation, create codebase maps, document code
  structure. Create ARCHITECTURE.md, generate mermaid diagrams, label modules
  and processes, write READMEs describing the codebase. NOT for exploring code
  (use exploring-codebases) or planning changes (use change-planning).
metadata:
  author: noodlbox
  version: "{{VERSION}}"

Generating Documentation

Create architecture documentation from the code knowledge graph.

Available Workflows

/noodlbox:generate_map

Generate comprehensive architecture documentation.

Creates ARCHITECTURE/ directory with:

  • •README.md - Main overview with mermaid diagram
  • •{process-slug}.md - Individual process files

Quick Start

code
1. Check for labels: Look for .noodlbox/labels.json (optional, can be created manually)
2. Run /noodlbox:generate_map

Workflow Checklist

Generate Architecture Map

code
Architecture Map:
- [ ] Check for .noodlbox/labels.json
- [ ] Read map://current for overview
- [ ] Drill into top communities
- [ ] Generate mermaid diagram
- [ ] Write ARCHITECTURE/README.md
- [ ] Create process files

Resources Used

map://current

Get codebase overview with communities and cross-flows.

code
repository: my-project
stats: { communities: 15, symbols: 2400, processes: 890 }
communities:
  - id: abc123, label: PaymentProcessing, symbols: 47
cross_flows:
  - from: PaymentProcessing, to: UserAuthentication, calls: 12

map://current/community/{id}

Get community detail with symbols and processes.

map://current/process/{id}

Get full execution trace for a process.

Mermaid Diagram Tips

mermaid
graph TB
    subgraph Auth["Authentication System"]
        login[login]
        validate[validateToken]
    end

    subgraph Payment["Payment Processing"]
        checkout[checkout]
        process[processPayment]
    end

    Auth -->|47 calls| Payment

Guidelines:

  • •Sanitize IDs: Replace spaces with underscores
  • •Use subgraphs for communities
  • •Add call counts on edges
  • •Keep labels short
  • •Use graph TB for top-to-bottom layout

For complete templates, see templates.md.

Example: Generate Architecture Map

Task: "Document the architecture of this codebase"

code
Step 1: Check for existing labels
Look for .noodlbox/labels.json
→ Not found (will use auto-generated names)

Step 2: Read overview
READ map://current
→ 15 communities, 2400 symbols, 890 processes
→ Top communities: PaymentProcessing, UserAuthentication, DataAccess

Step 3: Explore key communities
READ map://current/community/{payment-id}
→ Key symbols: validatePayment, processCharge
→ Entry points: handlePaymentRequest
→ 12 processes

Step 4: Generate README
Write ARCHITECTURE/README.md with:
- Summary from community analysis
- Stats from map
- Data flows from cross_flows
- Mermaid diagram from communities

Step 5: Generate process files
For each key process:
- Read map://current/process/{id}
- Write ARCHITECTURE/{process-slug}.md

Checklist:

code
- [x] Check for .noodlbox/labels.json (not found, using auto-generated names)
- [x] Read map overview (15 communities)
- [x] Drill into top communities
- [x] Generate mermaid diagram
- [x] Write ARCHITECTURE/README.md
- [x] Create process files

Output Structure

code
ARCHITECTURE/
├── README.md              # Main overview
├── checkout-flow.md       # Process: Checkout flow
├── user-login.md          # Process: User login
└── payment-processing.md  # Process: Payment processing

When to Use Something Else

NeedUse Instead
Explore code firstexploring-codebases skill
Check change impactchange-planning skill
Debug failing codedebugging skill
Plan refactoringrefactoring skill