Menu
生成接口文档、API文档。当用户需要编写接口文档、API文档、接口规范文档时使用此skill。
Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Baseado na classificação ocupacional SOC
生成运维手册、运维方案。当用户需要编写运维手册、运维方案、运维规范、故障处理手册时使用此skill。
生成中文软件项目规格文档（需求规格说明书、概要设计、详细设计）。使用python-docx生成符合国标的Word文档，包含封面、修订记录、目录、正文、附录等完整结构。当用户需要生成需求文档、设计文档、规格说明书时使用此skill。
生成测试计划、测试方案。当用户需要编写测试计划、测试方案、测试策略时使用此skill。
生成培训方案、培训计划。当用户需要编写培训方案、培训计划、培训资料时使用此skill。
生成验收报告、验收申请、项目总结。当用户需要编写验收报告、验收申请书、项目总结报告、交付物清单时使用此skill。
生成部署方案、部署手册、运维方案。当用户需要编写部署方案、部署手册、运维手册、环境配置方案、上线方案时使用此skill。
| name | api-doc |
| description | 生成接口文档、API文档。当用户需要编写接口文档、API文档、接口规范文档时使用此skill。 |
| 文档类型 | 侧重点 | 读者 |
|---|---|---|
| 技术规格说明书 | 系统架构、模块设计 | 开发人员、架构师 |
| 接口文档 | API定义、请求响应格式 | 前后端开发、测试人员 |
| 用户操作手册 | 功能使用说明 | 最终用户 |
1 概述
1.1 接口规范
1.2 认证方式
1.3 通用说明
2 接口清单
3 接口详情
3.1 模块1接口
3.2 模块2接口
4 错误码定义
5 数据字典
[单位名称] # 黑体 18pt，居中
[项目名称] # 黑体 18pt，居中
[文档标题] # 黑体 26pt，居中，加粗
[空行 × 6]
文档编号：XXX-XXX-XXX
版本号：V1.0
编制日期：YYYY年MM月DD日
密 级：内部
section.top_margin = Cm(2.54) # 上边距 2.54cm
section.bottom_margin = Cm(2.54) # 下边距 2.54cm
section.left_margin = Cm(3.17) # 左边距 3.17cm
section.right_margin = Cm(3.17) # 右边距 3.17cm
| 标题级别 | 字体 | 字号 | 对齐方式 |
|---|---|---|---|
| 一级标题 | 黑体 | 22pt（二号） | 左对齐 |
| 二级标题 | 黑体 | 16pt（三号） | 左对齐 |
| 三级标题 | 黑体 | 14pt（四号） | 左对齐 |
table.style = 'Table Grid' # 带边框表格
# 表头背景色
set_cell_shading(cell, 'D9E2F3') # 浅蓝色
{
"key": "value"
}
### 接口名称
**请求方式：** GET/POST/PUT/DELETE
**请求路径：** /api/xxx
**请求参数：**
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
**请求示例：**
```json
{}
响应参数：
| 参数名 | 类型 | 说明 |
|---|
响应示例：
{}
## 内容模板
### 接口清单章节模板
2 接口清单
[表格展示接口列表：模块、接口名称、方法、路径、说明]
### 错误码章节模板
4 错误码定义
[表格展示错误码、说明、处理建议]
### 数据字典章节模板
5 数据字典
[表格展示字典类型、编码、值、说明]
## 代码示例
### 基础模板
```python
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""接口文档生成模板"""
from skills.utils import create_doc, add_cover, add_revision, add_toc, T, P, B
def gen_api_doc(output_path):
doc = create_doc()
add_cover(doc, '接 口 文 档', {'文档编号：':'API-YJZHDD-2024-001','版本号：':'V1.0','编制日期：':'2024年03月01日','密 级：':'内部'})
add_revision(doc)
add_toc(doc)
doc.add_heading('1 概述', level=1)
doc.add_heading('1.1 接口规范', level=2)
P(doc, '本系统接口遵循RESTful设计规范，统一使用JSON格式进行数据交换。')
doc.save(output_path)
print(f'已生成：{output_path}')
if __name__ == '__main__':
gen_api_doc('api_doc.docx')
所有技能共享以下工具函数，统一从 skills.utils 导入：
| 函数名 | 说明 | 参数 |
|---|---|---|
create_doc() | 创建格式化文档对象 | 无 |
add_cover(doc, title, doc_info, unit_name, project_name) | 添加封面页 | doc:文档对象, title:文档标题, doc_info:信息字典 |
add_revision(doc) | 添加修订记录表 | doc:文档对象 |
add_toc(doc) | 添加目录页 | doc:文档对象 |
T(doc, headers, rows) | 创建表格 | headers:表头列表, rows:数据行列表 |
P(doc, text, style) | 添加段落 | text:文本内容, style:段落样式(可选) |
B(doc, text) | 添加加粗段落 | text:文本内容 |