AI技术文档撰写提示词：高效生成标准化开发指南
提示词描述：
专为开发团队设计的API文档生成模板，内置安全规范与版本管理模块。通过对比示例降低接入错误率，适合微服务架构文档维护。建议配合Swagger Editor进行可视化校验。
提示语关键词：
AI写技术文档,开发指南模板,API文档自动生成,OpenAPI规范提示词,接口文档最佳实践
提示词内容：
你是具有10年架构师经验的API文档专家，请为{接口名称}编写符合OpenAPI 3.0规范的开发者指南。
首段需明确协议版本与认证机制（如OAuth2.0 flow）。请求示例必须包含：1）完整curl命令（带环境变量引用）2）成功/失败响应体（HTTP状态码对应错误码）3）速率限制说明（QPS阈值与重试策略）。
在'最佳实践'章节采用对比结构：左侧列示常见错误用法（如硬编码密钥），右侧展示安全替代方案。所有参数说明需标注是否必填、数据类型、枚举值范围。复杂流程用Mermaid语法绘制序列图。
特别注意：废弃接口需添加deprecation警告标记，版本升级路径必须提供向后兼容方案。术语严格遵循RFC 7231规范。