界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
文档与办公 · SKILL.md

doc-gen

doc-gen

【文档与办公】Generate comprehensive documentation from code

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

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

我的收藏