后端接口On-Prem私有化文档高阶版提示词

角色定义与任务定位

请以资深后端架构师兼技术文档工程师的身份，执行本次内容生成任务。你的核心目标是：为即将进行On-Prem私有化部署的企业级软件，创作一套专业、清晰、可执行的后端接口文档高阶版本。这份文档需超越基础API列表，深入涵盖部署上下文、安全规范、运维对接等私有化场景下的关键信息，确保交付给客户的技术团队能够独立、顺利地进行集成与运维。

适用场景

• 向采购方交付私有化部署软件时的配套接口技术文档。
• 内部团队为特定客户定制化开发后的接口说明归档。
• 为运维团队提供的，包含环境变量、健康检查、监控指标的深度集成指南。
• 在涉及敏感数据或内外网隔离的项目中，明确接口访问边界与安全要求的权威文档。

核心提示词

可直接复制或组合使用的提示词核心结构：

• “生成一份面向On-Prem私有化部署的[系统名称]后端RESTful接口文档，需包含部署前置条件、网络拓扑说明、API端点列表（含请求/响应示例）、鉴权机制（如JWT或API Key）、以及私有化环境特有的配置项（如许可证服务器地址、本地文件存储路径）。”
• “详细说明在私有化环境中，接口如何与客户的现有[例如：AD/LDAP]系统进行用户身份集成，并提供分步配置示例。”
• “撰写接口文档的‘运维指南’章节，内容需涵盖：服务启停脚本、日志文件位置与格式、关键性能监控指标（Prometheus格式）、以及常见故障排查流程图。”
• “对比SaaS版与On-Prem私有化版在接口速率限制、数据隔离策略、回调地址（Callback URL）配置上的核心差异，并以表格形式呈现。”

风格方向

• 文体风格：采用严谨、客观、无歧义的技术文档风格。避免营销性语言，多使用定义性、指令性语句。
• 视觉基调：专业、冷静、可靠。可设想为深色系或中性色背景下的结构化排版，强调清晰的层级划分和代码高亮。
• 内容气质：体现权威性与完整性，如同交付一份“产品的一部分”，而非附属说明。注重逻辑链条的严密性。

构图建议（信息组织框架）

• 顶层架构图：首先以一张逻辑拓扑图，展示On-Prem环境中，后端服务与客户本地数据库、防火墙、身份认证源等组件的关系。
• 分层式目录：文档主体采用“总-分”结构。第一部分全局说明（版本、修订记录、文档约定）；第二部分部署与配置（环境要求、安装步骤、初始化配置）；第三部分API核心文档（按业务模块分组）；第四部分运维与支持（监控、告警、FAQ）。
• 对比区块：关键配置项旁，设置“默认值（SaaS）”与“私有化建议值”的对比注释，突出差异。
• 流程图嵌入：对于复杂的鉴权流程或数据同步流程，使用标准流程图进行可视化说明。

细节强化

• 关键词定义：在文档开头明确定义“私有化环境”、“内网端点”、“离线激活”等本项目中的特定术语。
• 配置项具体化：所有配置项需给出示例值，并说明来源（如配置文件`application-onprem.yml`或环境变量`APP_DB_HOST`）。
• 错误码专章：私有化场景特有的错误码（如“无法连接许可证服务”、“内网域名解析失败”）需单独列出，并附上可能原因与解决步骤。
• 安全红线标注：对于必须由客户侧配置的密钥、或严禁暴露的接口，使用明显的【安全警告】框进行突出提示。
• 版本关联：在文档页眉或页脚明确标注此文档对应的软件版本号及最后更新时间，确保版本可控。

使用建议

• 生成内容后，请务必将“[系统名称]”、“[例如：AD/LDAP]”等占位符替换为项目的真实信息。
• “核心提示词”中的每一条均可独立扩展，或组合使用以生成完整文档的不同章节。
• 建议将生成的“运维指南”部分单独输出一份简版手册，交付给客户的运维团队。
• 在最终文档中，所有API示例应确保JSON格式正确，并可使用工具进行语法验证，以提升专业性。
• 此提示词方案同样适用于编写类似的“部署手册”、“集成指南”，可根据具体需求微调侧重点。