高质量多语言站点API文档生成提示词

角色定义与任务定位

请以“多语言技术文档架构师”的身份，运用本方案。你的核心目标是：系统化地生成或指导生成一套技术精准、术语统一、符合目标语言文化习惯的高质量API文档，服务于全球开发者，提升产品的技术可信度与开发者体验。

适用场景

• 为支持多语言（如中、英、日、西等）的Web服务或SDK生成官方API参考文档。
• 将现有单语API文档高效、准确地扩展为多语言版本。
• 建立和维护跨团队、跨地区的标准化API文档写作规范。
• 在CI/CD流程中集成自动化文档生成与多语言同步检查。

核心提示词（可直接使用）

• 生成一份关于 [具体API端点名称，如：/user/login] 的RESTful API文档，要求包含：端点路径、HTTP方法、请求头、请求体参数（类型、必填、示例）、成功响应（状态码、数据结构示例）、错误码列表。
• 将上述API文档的核心技术描述与参数定义，专业地翻译为 [目标语言，如：日语]，并确保技术术语与 [如：日本开发者社区常用术语] 保持一致。
• 为以下API函数签名生成使用示例代码：[粘贴函数签名]，示例需包含 [语言，如：Python] 和 [语言，如：JavaScript] 两种版本，并附上关键行注释。
• 基于OpenAPI Specification (Swagger) 3.0标准，为 [服务名称] 生成结构化的YAML格式定义，需包含info、servers、paths、components等核心部分，并标注支持多语言的可扩展字段。

风格方向

• 专业严谨：采用技术文档的客观、准确、无歧义的行文风格，避免营销化或模糊表述。
• 一致性优先：确保同一术语（如“endpoint”、“payload”、“authentication”）在所有语言版本中翻译一致。
• 本地化友好：针对目标语言调整句子长度、语法结构，并考虑日期、数字、货币等格式的本地化展示。
• 视觉层级清晰：在最终呈现上，利用标题层级、代码块高亮、表格、颜色区分（请求/响应）来建立清晰的视觉逻辑。

构图建议（文档结构布局）

• 顶层导航：按功能模块（如：认证、用户管理、订单）划分主要章节，支持语言切换器。
• 页面结构：单API页面建议采用“概述 -> 快速开始 -> 详细参数 -> 响应示例 -> 错误处理 -> 常见问题”的流线型布局。
• 信息密度控制：合理运用折叠面板（用于长示例或可选参数）和锚点链接，平衡信息的完整性与首页的可读性。
• 多语言对照：可提供“并排对照”或“一键切换”模式，方便开发者进行跨语言核对。

细节强化

• 参数描述：不仅说明“是什么”，补充“为什么”和“可能的值”，例如：“status: (string) 订单状态，可选值：‘pending’（待处理）、‘shipped’（已发货），默认为‘pending’。”
• 实时性提示：对可能变更的速率限制、配额等信息，添加“最后更新于 [日期]”的标识。
• 交互元素：集成“一键复制代码”按钮、可编辑并发送的API测试控制台（如Swagger UI）。
• 辅助图形：在复杂流程处，考虑加入简单的序列图或状态转换图，使用Mermaid等文本化图表语法描述。

使用建议

• 在使用AI生成初稿后，务必由目标语言为母语的技术专家进行审校，确保技术准确性与语言地道的双重质量。
• 建立并维护一份多语言术语对照表，作为团队协作和AI生成的共同依据，这是保证一致性的关键。
• 将核心提示词与自动化工具（如Swagger Codegen、Redocly）结合，实现“提示词定义规范 -> 工具生成骨架 -> 人工润色与本地化”的高效流水线。
• 定期使用链接检查器和代码示例验证器，确保多语言文档的可用性与示例代码的时效性。