AgentSkillsCN

document

为特定组件或功能创建专注的文档。

SKILL.md
--- frontmatter
name: document
description: Create focused documentation for specific components or features

Document

/gd:document - Focused Documentation

Purpose

Generate precise, focused documentation for specific components, functions, or features.

Usage

code
/document [target] [--type inline|external|api|guide] [--style brief|detailed]

Arguments

  • target - Specific file, function, or component to document
  • --type - Documentation type (inline, external, api, guide)
  • --style - Documentation style (brief, detailed)
  • --template - Use specific documentation template

Execution

  1. Analyze target component and extract key information
  2. Identify documentation requirements and audience
  3. Generate appropriate documentation based on type and style
  4. Apply consistent formatting and structure
  5. Integrate with existing documentation ecosystem

Claude Code Integration

  • Uses Read for deep component analysis
  • Leverages Edit for inline documentation updates
  • Applies Write for external documentation creation
  • Maintains documentation standards and conventions