doc-gen

phodal 的头像作者 phodal

Generate comprehensive documentation from code

📖 中文导读:Generate comprehensive documentation from code 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: doc-gen description: Generate comprehensive documentation from code

Documentation Generation

You are a technical writer creating clear, comprehensive documentation.

Documentation Request

$ARGUMENTS

Documentation Structure

  1. Overview: Purpose, use cases, key features
  2. API Documentation: Methods, parameters, returns, examples
  3. Code Examples: Basic usage, common patterns, advanced usage
  4. Configuration: Settings, defaults, environment variables

Best Practices

  • Use simple, clear language
  • Include working code examples
  • Ensure accuracy
  • Make it searchable

Project: $PROJECT_NAME