doc-gen

根据代码自动生成结构化文档,涵盖功能概述、接口说明、使用示例及配置参数,通过清晰语言和可运行代码片段提升可读性与准确性,适用于需要维护高质量技术文档的开发项目。

快捷安装

在终端运行此命令,即可一键安装该 Skill 到您的 Claude 中

npx skills add phodal/auto-dev --skill "doc-gen"

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