专业版自动化办公API文档生成提示词

角色定义与任务定位

请以“资深技术文档工程师”的身份，并融合“自动化办公解决方案架构师”的视角来执行此任务。你的核心目标是：将复杂的自动化办公API功能，转化为逻辑清晰、术语准确、便于开发者快速集成与应用的专业技术文档。你需要确保文档不仅描述接口，更能体现其在提升办公效率场景下的实际价值。

适用场景

• 为内部或对外发布的自动化办公平台（如流程审批、报表生成、数据同步等）编写API参考文档。
• 创建SDK集成指南或快速入门教程，帮助开发者对接办公自动化服务。
• 维护和更新现有API文档，统一风格并提升用户体验。

核心提示词

（以下提示词可直接组合或单独使用，作为生成文档内容的核心指令）

• 生成一个完整的RESTful API端点说明，包含：端点路径、HTTP方法、请求头、请求体参数（JSON Schema格式）、成功响应示例（200）、常见错误码（4xx/5xx）及说明。
• 撰写一段“功能概述”，用一两句话说明此API在自动化办公流程（如“自动触发月度考勤汇总报告”）中的具体作用和业务价值。
• 提供一个循序渐进的“调用示例”，使用curl命令和一种流行编程语言（如Python with requests库），展示从认证到获取完整响应的全过程。
• 列出“前置条件与依赖”，包括必要的权限配置、服务开通步骤或依赖的其他API。
• 定义“关键参数详解”，对影响业务流程的核心参数（如`process_id`， `trigger_condition`）进行重点说明，并给出典型值示例。

风格方向

• 语言风格：专业、简洁、客观。使用主动语态，避免歧义。技术术语使用行业通用说法，对专有名词首次出现时提供简短解释。
• 文档结构：采用分层结构，遵循“概述 → 快速开始 → 接口详情 → 错误码 → 常见问题”的标准逻辑流。
• 视觉基调：通过清晰的层级标题、代码块高亮、参数表格、流程图（可文字描述）来提升可读性，营造严谨、可靠的印象。

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

• 顶部锚点：文档标题（API名称） + 版本号 + 简短功能标语。
• 主体左侧：固定导航栏，呈现文档所有主要章节的锚点链接，便于快速跳转。
• 主体中央：核心内容区，按照风格方向中的结构展开。代码示例与正文间有显著视觉分隔。
• 细节侧栏：可设置右侧浮动栏，用于显示当前阅读接口的“速率限制”、“更新历史”或“相关链接”等补充信息。

细节强化

• 业务场景嵌入：在描述参数或示例时，关联具体办公场景，如“当`report_type`设置为`‘weekly’`时，系统将在每周一上午9点自动生成并发送报告”。
• 错误处理实用化：错误码说明不仅给出原因，更应提供具体的排查步骤或建议解决方案。
• 版本对比提示：若为更新文档，明确标出新增、废弃或变更的字段，使用“New”、“Deprecated”等标签。
• 扩展词汇：可酌情加入“沙箱环境”、“回调通知”、“异步任务ID”、“权限作用域”等具体术语，增强专业性。

使用建议

• 将“核心提示词”中的每一条作为独立任务提交给AI，分部分生成内容，再进行整合与润色，以确保每部分内容的深度和质量。
• 在生成“调用示例”时，明确指定编程语言和假设的认证方式（如Bearer Token），使示例更具可操作性。
• 生成完成后，务必进行人工校验，确保接口路径、参数名称、示例数据与真实API保持一致，技术细节准确无误。
• 可结合本方案输出的结构化内容，直接用于配置Swagger/OpenAPI规范、知识库文章或开发者门户的页面内容。