Agent Skills
› phodal/auto-dev
› doc-gen
doc-gen
GitHub根据代码自动生成技术文档,涵盖概述、API、示例及配置,遵循最佳实践确保内容清晰准确。
Trigger Scenarios
需要生成项目文档
基于代码创建API说明
Install
npx skills add phodal/auto-dev --skill doc-gen -g -y
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
- Overview: Purpose, use cases, key features
- API Documentation: Methods, parameters, returns, examples
- Code Examples: Basic usage, common patterns, advanced usage
- 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


