文档安装

Step 0: Resolve Project Context (ALWAYS first)

# Forge-agnostic remote URL parser — supports GitHub, GitLab, Bitbucket, Azure DevOps, Gitea, self-hosted
REMOTE_URL=$(git remote get-url origin 2>/dev/null || echo "")
if echo "$REMOTE_URL" | grep -q 'dev\.azure\.com'; then
  GIT_HOST="dev.azure.com"
  GIT_OWNER=$(echo "$REMOTE_URL" | sed 's|.*dev\.azure\.com/||; s|/.*||')
  GIT_REPO=$(echo "$REMOTE_URL" | sed 's|.*/_git/||; s|\.git$||; s|/$||')
elif echo "$REMOTE_URL" | grep -q '^git@'; then
  GIT_HOST=$(echo "$REMOTE_URL" | sed 's|^git@||; s|:.*||')
  GIT_OWNER=$(echo "$REMOTE_URL" | sed 's|^git@[^:]*:||; s|/.*||')
  GIT_REPO=$(echo "$REMOTE_URL" | sed 's|^git@[^:]*:[^/]*/||; s|\.git$||')
else
  GIT_HOST=$(echo "$REMOTE_URL" | sed 's|^https\?://||; s|/.*||')
  GIT_OWNER=$(echo "$REMOTE_URL" | sed 's|^https\?://[^/]*/||; s|/.*||')
  GIT_REPO=$(echo "$REMOTE_URL" | sed 's|^https\?://[^/]*/[^/]*/||; s|\.git$||; s|/$||')
fi
# Fallback: use searchable placeholder, not 'your-org'
[ -z "$GIT_OWNER" ] && GIT_HOST="{GIT_HOST}" && GIT_OWNER="{GIT_OWNER}" && GIT_REPO="{GIT_REPO}"

ACTUAL_SKILLS=$(ls skills/*/SKILL.md 2>/dev/null | wc -l | tr -d ' ')
ACTUAL_WORKFLOWS=$(ls workflows/*.md 2>/dev/null | wc -l | tr -d ' ')

Use $GIT_HOST, $GIT_OWNER, $GIT_REPO in all generated files. Use $ACTUAL_SKILLS and $ACTUAL_WORKFLOWS for counts. Never write your-org, YOUR_USERNAME, YOUR_ORG into generated files.

Step 0A: ViePilot active profile (FEAT-009)

After Step 0: resolve .viepilot/META.md → global profile file (same rules as workflows/crystallize.md). Keep working notes (org, website, audience, branding) for prose docs; do not fail if missing. Details: workflows/documentation.md §0A.

Step 1: Ask Documentation Scope

Which documentation would you like to generate?

1. All - Generate complete documentation
2. API - REST, GraphQL, Kafka, WebSocket docs
3. Developer Guide - Setup, architecture, contributing
4. User Guide - Quick start, feature guides
5. Changelog - Update from git history

Step 2A: API Documentation

sources:
  - Code annotations (@OpenAPI, @GraphQL)
  - .viepilot/schemas/api-contracts.yaml
  - Controller/Resolver classes
  - Kafka topic definitions

generate:
  rest-api.md:
    - Endpoints grouped by resource
    - Request/Response examples
    - Authentication requirements
    - Error codes
    
  graphql-schema.md:
    - Types and queries
    - Mutations
    - Subscriptions
    - Example queries
    
  kafka-events.md:
    - Topic list with descriptions
    - Message schemas
    - Producer/Consumer examples
    
  websocket-api.md:
    - Connection flow
    - Event types
    - Message formats

Step 2B: Developer Guide

sources:
  - .viepilot/ARCHITECTURE.md
  - .viepilot/SYSTEM-RULES.md
  - .viepilot/PROJECT-CONTEXT.md
  - README.md
  - Docker/deployment configs

generate:
  getting-started.md:
    - Prerequisites
    - Local setup steps
    - Running the project
    - Common issues
    
  architecture.md:
    - System overview (from ARCHITECTURE.md)
    - Service descriptions
    - Data flow diagrams
    
  contributing.md:
    - Development workflow
    - Code standards
    - PR process
    - Testing requirements
    
  testing.md:
    - Test structure
    - Running tests
    - Writing new tests
    - Coverage requirements
    
  deployment.md:
    - Environments
    - Deployment steps
    - Configuration
    - Monitoring

Step 2C: User Guide

sources:
  - Feature specs from phases
  - UI components (if frontend)
  - Business rules from PROJECT-CONTEXT.md

generate:
  quick-start.md:
    - Getting started
    - Basic usage
    - Common tasks
    
  features/:
    - One file per major feature
    - Screenshots if UI
    - Step-by-step guides
    
  faq.md:
    - Common questions
    - Troubleshooting

Step 2D: Changelog Update

sources:
  - Git commits since last version
  - .viepilot/TRACKER.md decision log
  - Phase SUMMARY.md files

process:
  1. Parse commits by type (feat, fix, etc.)
  2. Group by category (Added, Changed, Fixed, etc.)
  3. Add to [Unreleased] section
  4. Include commit references

Step 3: Generate Files

Use templates and extracted content to generate markdown files.

Step 3B: Update skills-reference.md (incremental)

# Scan skills/ directory — source of truth
SKILLS=$(ls skills/*/SKILL.md 2>/dev/null | sed 's|skills/||; s|/SKILL.md||' | sort)
DOCUMENTED=$(grep "^## /vp-" docs/skills-reference.md 2>/dev/null | sed 's|## /||' | sort)
MISSING=$(comm -23 <(echo "$SKILLS") <(echo "$DOCUMENTED"))

For each skill in $MISSING: append section to docs/skills-reference.md. Do NOT overwrite existing sections (preserve manual edits).

Step 4: Create Index

Update docs/README.md with:

• Documentation index
• Quick links
• Last updated date

Also update root README.md:

• Documentation table: add links to newly generated docs
• Project Structure docs/ tree: reflect actual subdirectories

Step 5: Commit

git add docs/ CHANGELOG.md
git commit -m "docs: update documentation"

Step 6: Confirm

✓ Documentation generated

Files created/updated:
- docs/api/ ({count} files)
- docs/dev/ ({count} files)
- docs/user/ ({count} files)
- CHANGELOG.md

View at: docs/README.md