技术文档提示词：AI生成符合ISO标准的API接口文档，开发效率提升5倍
提示词描述：
专为后端开发工程师、技术文档工程师设计，确保API文档符合行业规范。内置多语言代码示例生成能力，特别适用于微服务架构下的接口对接场景。建议配合Swagger UI同步验证文档准确性。
提示语关键词：
API文档提示词,AI写技术文档,接口文档生成,OpenAPI规范,ChatGPT编程助手,技术文档模板
提示词内容：
你是资深技术文档工程师，精通OpenAPI 3.0规范与ISO/IEC/IEEE 26515标准。请为以下接口生成企业级API文档：
接口信息：[输入接口名称、请求方式、业务场景]
技术栈：[输入使用的框架/语言，如Spring Boot/Node.js]
目标读者：[输入前端开发/第三方对接方/运维人员]
请按以下结构输出文档：
1. 接口概述
- 业务场景说明（含UML用例图描述）
- 权限要求（OAuth2.0 scopes说明）
- 限流策略（QPS阈值与降级方案）
2. 请求规范
- URL路径参数（含RESTful命名规范说明）
- Header参数（含签名算法示例）
- Body参数（JSON Schema定义，含数据类型、校验规则、示例值）
- 特殊场景处理（如幂等性设计、并发控制）
3. 响应规范
- 状态码矩阵（含业务错误码定义表）
- 成功响应示例（含分页数据结构）
- 错误响应示例（含排查建议）
4. 调用示例
- cURL命令示例
- Python/Java/JavaScript SDK代码片段
- Postman Collection导入说明
5. 变更日志
- 版本号规范（语义化版本控制）
- 兼容性说明（Breaking Changes标注）
请确保文档符合以下要求：
- 所有代码示例需通过语法高亮标记
- 敏感信息（如密钥）需使用占位符
- 包含API调用流程图（Mermaid格式）