AgentSkillsCN

Documentation Skill

依据团队标准,为代码生成全面的文档。适用于需要记录函数、类、API或模块时使用。

SKILL.md
--- frontmatter
name: Documentation Skill
description: Generates comprehensive documentation for code following team standards. Use when you need to document functions, classes, APIs, or modules.

Documentation Skill

This skill provides structured documentation generation capabilities. The agent discovers and activates this skill when documentation tasks are detected.

Capabilities

  1. Code Documentation — JSDoc, TSDoc, docstrings for functions and classes
  2. API Reference — Structured documentation of public interfaces
  3. README Generation — Project overviews with setup and usage
  4. Usage Guides — Examples and tutorials for complex features

Skill Components

ComponentPurpose
InstructionsDocumentation standards and patterns
PromptsReusable documentation generation prompt
ReferencesDocumentation templates and examples