Agent skill

doc-generator

技术文档生成技能。当用户需要编写 README、API 文档、项目文档、技术规范、使用指南或任何技术文档时使用此技能。

View SKILL.md on GitHub Repository
Stars 0
Forks 0

Install this agent skill to your Project

npx add-skill https://github.com/enoch-robinson/agent-skill-collection/tree/main/skills/documents/doc-generator

SKILL.md

Doc Generator

生成专业、清晰、结构化的技术文档。

文档类型

README.md 结构

markdown
# 项目名称
简短描述（一句话）

## 功能特性
- 特性1
- 特性 2

## 快速开始
### 安装
### 使用

## 配置说明

## API 文档（如适用）

## 贡献指南

## License

API 文档结构

markdown
## 接口名称
简要描述

### 请求
- Method: GET/POST/...
- URL: /api/v1/resource
- Headers: ...
- Body: ...

### 响应
- 成功响应示例
- 错误响应示例

### 示例代码

文档原则

  1. 用户优先：从读者角度出发
  2. 示例驱动：代码示例胜过长篇描述
  3. 保持更新：文档与代码同步
  4. 结构清晰：使用标题层级组织内容

写作规范

  • 使用主动语态
  • 句子简短明确
  • 专业术语首次出现时解释
  • 代码块标注语言类型
  • 重要信息使用提示框

提示框格式

markdown
>⚠️ **警告**：重要警告信息

> 💡 **提示**：有用的建议

> 📝 **注意**：需要注意的事项

Recommended Agent Skills

Expand your agent's capabilities with these related and highly-rated skills.

enoch-robinson/agent-skill-collection

your-skill-name

清晰描述这个 Skill 的功能以及何时使用它。包含触发条件和使用场景。

0 0
Explore
enoch-robinson/agent-skill-collection

changelog-writer

变更日志编写技能。当用户需要编写 CHANGELOG、版本发布说明、更新记录，或需要整理 Git 提交历史生成变更日志时使用此技能。

0 0
Explore
enoch-robinson/agent-skill-collection

pdf

PDF 处理工具包。用于提取文本和表格、创建新 PDF、合并拆分文档、旋转页面、处理表单。当需要程序化处理、生成或分析 PDF 文档时使用此技能。

0 0
Explore
enoch-robinson/agent-skill-collection

docx

Word 文档处理工具包。用于创建新文档、编辑现有文档、处理修订追踪、添加批注、提取文本。当需要处理 .docx 文件进行文档创建、修改或分析时使用此技能。

0 0
Explore
enoch-robinson/agent-skill-collection

xlsx

Excel 电子表格处理工具包。用于创建和编辑电子表格、数据分析、公式计算、格式化。当需要处理 .xlsx/.csv 文件进行数据操作、报表生成或财务建模时使用此技能。

0 0
Explore
enoch-robinson/agent-skill-collection

frontend-design

前端界面设计技能。创建独特、高质量的前端界面，避免通用 AI 风格。当用户需要构建网站、落地页、仪表盘、React 组件、HTML/CSS 布局或美化任何 Web UI 时使用此技能。

0 0
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results