text
# API接口文档生成Prompt模板（可直接复制修改）
需求：帮我撰写一份“用户信息查询API”的技术文档，需符合RESTful规范，包含以下核心内容：1. 接口概述（功能、适用场景）；2. 接口信息（请求地址、请求方式、请求头）；3. 参数说明（路径参数/请求参数，含名称、类型、是否必填、说明）；4. 请求示例（curl命令）；5. 返回示例（成功/失败）；6. 错误码说明；7. 注意事项。
补充信息：接口功能为“根据用户ID查询用户基础信息（姓名、手机号、所属部门）”，请求方式为GET，请求地址为/api/v1/user/query，用户ID为路径参数。

text
# AI生成框架的微调示例（补充细节后）
## 3. 参数说明
| 参数名称 | 类型 | 位置 | 是否必填 | 说明 | 取值范围 |
|----------|--------|--------|----------|---------------------|----------------|
| userId | String | 路径 | 是 | 用户唯一标识 | 6-12位数字字符串 |

## 4. 请求示例（curl）
curl -X GET "https://api.example.com/api/v1/user/query/100001" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

## 6. 错误码说明
| 错误码 | 说明 | 解决方案 |
|--------|-----------------------|-----------------------------------|
| 400 | 参数错误（userId无效） | 检查userId格式，确保为6-12位数字 |
| 401 | 未授权 | 补充Authorization请求头 |
| 404 | 用户不存在 | 确认userId是否正确 |

python
import docx
from docx.shared import Pt
from docx.enum.text import WD_ALIGN_PARAGRAPH
import os

# 批量统一API接口文档格式（适用于docx文件）
def unify_api_doc_format(doc_path, output_path):
# 打开文档
doc = docx.Document(doc_path)

# 1. 统一标题格式（二级标题）
for para in doc.paragraphs:
if para.style.name == 'Heading 2':
para.alignment = WD_ALIGN_PARAGRAPH.LEFT
run = para.runs[0]
run.font.name = 'Arial'
run.font.size = Pt(14)
run.font.bold = True

# 2. 统一正文格式
for para in doc.paragraphs:
if para.style.name == 'Normal':
para.alignment = WD_ALIGN_PARAGRAPH.LEFT
run = para.runs[0]
run.font.name = 'Arial'
run.font.size = Pt(11)

# 3. 统一表格格式
for table in doc.tables:
for row in table.rows:
for cell in row.cells:
# 统一单元格文本格式
for para in cell.paragraphs:
run = para.runs[0]
run.font.name = 'Arial'
run.font.size = Pt(10)
# 单元格居中对齐
cell.vertical_alignment = docx.enum.table.WD_ALIGN_VERTICAL.CENTER

# 保存统一格式后的文档
doc.save(output_path)
print(f"文档 {os.path.basename(doc_path)} 格式统一完成，保存至 {output_path}")

# 批量处理文件夹内所有接口文档
def batch_unify_doc_format(input_folder, output_folder):
# 创建输出文件夹
if not os.path.exists(output_folder):
os.makedirs(output_folder)

# 遍历输入文件夹内的docx文件
for filename in os.listdir(input_folder):
if filename.endswith('.docx'):
doc_path = os.path.join(input_folder, filename)
output_path = os.path.join(output_folder, filename)
unify_api_doc_format(doc_path, output_path)

# 执行批量处理（替换为你的输入/输出文件夹路径）
batch_unify_doc_format('./api_docs_input', './api_docs_output')

text
# 技术人员周汇报生成Prompt模板
需求：帮我撰写一份技术人员周汇报框架，需突出工作成果和业务价值，包含以下核心内容：1. 本周核心工作成果（按优先级排序，配数据支撑）；2. 项目进度同步（未完成任务、进度偏差及原因）；3. 遇到的问题及解决方案；4. 下周工作计划（明确目标和时间节点）；5. 需协调的资源。
补充信息：本周核心工作是“完成用户管理模块开发”“修复3个线上bug”，项目为电商后台管理系统，下周计划完成模块测试。

text
# 优化后的周汇报示例（AI生成+人工补充）
## 一、本周核心工作成果（按优先级）
1. 完成用户管理模块开发：实现用户注册、登录、信息修改3个核心功能，开发文档已同步至语雀；接口响应时间≤500ms，比预期指标提升20%，支持每日10万用户访问；
2. 修复3个线上bug：其中2个支付相关bug，修复后支付成功率从98.5%提升至99.8%，减少订单流失；1个数据查询bug，优化后查询效率提升30%；
3. 完成模块接口联调：与前端团队配合完成5个接口联调，联调通过率100%，为后续测试环节奠定基础。

## 二、项目进度同步
- 本周计划完成任务：100%完成；
- 整体项目进度：当前进度35%，符合项目计划（预期35%），无进度偏差。

## 三、遇到的问题及解决方案
1. 问题：用户登录接口并发测试时出现性能瓶颈；
2. 解决方案：优化数据库查询语句，添加缓存机制（Redis），优化后并发支持量从500QPS提升至2000QPS；
3. 后续预防：后续开发中提前进行并发测试，避免类似问题。

## 四、下周工作计划
1. 完成用户管理模块测试：配合测试团队完成功能测试、性能测试，本周三前提交测试报告；
2. 开始订单管理模块开发：完成需求分析和技术方案设计，本周五前输出开发计划；
3. 参加项目需求评审会：同步开发进度，确认订单模块需求细节。

## 五、需协调的资源
1. 测试环境资源：需运维团队本周一前搭建完成用户管理模块专属测试环境；
2. 接口文档评审：需产品团队本周二前完成用户管理模块接口文档评审。

python
import pandas as pd
import openai

# 读取Excel中的接口参数数据，批量生成接口测试用例文档
def batch_generate_test_case(excel_path, output_doc_path):
# 读取Excel数据（包含接口名称、参数、预期结果等字段）
df = pd.read_excel(excel_path)

# 初始化OpenAI客户端（替换为你的API密钥）
openai.api_key = "your-api-key"

# 生成测试用例文档内容
test_case_content = "# 接口测试用例集合\n\n"
for idx, row in df.iterrows():
# 构造Prompt
prompt = f"帮我生成“{row['接口名称']}”的测试用例，包含测试目的、测试环境、测试步骤、输入参数、预期结果。补充信息：输入参数为{row['参数']}，预期结果为{row['预期结果']}，测试环境为测试服。"

# 调用AI生成测试用例
response = openai.ChatCompletion.create(
model="gpt-3.5-turbo",
messages=[{"role": "user", "content": prompt}]
)

# 拼接生成的测试用例
test_case_content += f"## {idx+1}. {row['接口名称']}\n"
test_case_content += response.choices[0].message.content + "\n\n"

# 保存测试用例文档
with open(output_doc_path, 'w', encoding='utf-8') as f:
f.write(test_case_content)

print(f"批量生成测试用例完成，保存至 {output_doc_path}")

# 执行批量生成（替换为你的Excel路径和输出路径）
batch_generate_test_case('./api_test_data.xlsx', './api_test_cases.md')