AgentSkillsCN

Documentation Generator

为代码文件与项目生成文档

SKILL.md
--- frontmatter
name: Documentation Generator
description: Generates documentation for code files and projects
trigger_patterns:
  - "document this"
  - "generate docs"
  - "create documentation"

Documentation Generator Skill

This skill helps generate comprehensive documentation for code.

When to Use

Claude should invoke this skill when:

  • •User asks to document code or a project
  • •User needs README or API documentation
  • •User wants to generate code comments

Behavior

  1. •Analyze the code structure
  2. •Identify public APIs and key functions
  3. •Generate clear, concise documentation
  4. •Follow project documentation conventions if they exist