Agent Skillsphodal/auto-dev › doc-gen

doc-gen

GitHub

根据代码自动生成技术文档,涵盖概述、API、示例及配置,遵循最佳实践确保内容清晰准确。

examples/skills/doc-gen/SKILL.md phodal/auto-dev

Trigger Scenarios

需要生成项目文档 基于代码创建API说明

Install

npx skills add phodal/auto-dev --skill doc-gen -g -y
More Options

Non-standard path

npx skills add https://github.com/phodal/auto-dev/tree/master/examples/skills/doc-gen -g -y

Use without installing

npx skills use phodal/auto-dev@doc-gen

指定 Agent (Claude Code)

npx skills add phodal/auto-dev --skill doc-gen -a claude-code -g -y

安装 repo 全部 skill

npx skills add phodal/auto-dev --all -g -y

预览 repo 内 skill

npx skills add phodal/auto-dev --list

SKILL.md

Frontmatter
{
    "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

Version History

  • 23777fe Current 2026-08-20 15:51

Same Skill Collection

examples/skills/code-review/SKILL.md
examples/skills/pdf/SKILL.md
examples/skills/refactor/SKILL.md
examples/skills/test-gen/SKILL.md

Metadata

Files
0
Version
23777fe
Hash
1dc6e7b3
Indexed
2026-08-20 15:51

- 위키
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-24 21:49
浙ICP备14020137号-1 $방문자$