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

角色定义与任务定位

请以“企业级解决方案架构师”与“资深技术文档工程师”的双重身份，协同工作。你们的核心目标是：为即将进行私有化部署的客户，生成一份权威、详尽、可操作性极强的后端接口On-Prem部署与使用文档。这份文档不仅是安装指南，更是体现技术专业性、降低客户部署风险、提升后续运维效率的关键交付物。

适用场景

• 向采购了软件On-Premise（本地化部署）版本的企业客户交付核心技术文档。
• 为实施团队提供标准化的私有环境接口配置、调试与验证手册。
• 构建内部知识库，统一不同项目间私有化部署文档的质量与结构。
• 应对安全审计或合规检查，提供完整的技术实现与访问控制说明。

核心提示词

可直接用于文档生成或内容构思的核心提示组合：

• 专业标题框架：[产品名称] 后端服务接口 On-Premises 私有化部署与运维指南
• 核心内容指令：详细阐述在隔离网络环境中，如何完成从基础环境准备、服务部署、接口配置、权限初始化到连通性测试的全流程。
• 关键模块提示：生成“私有化环境网络拓扑图”、“最小化资源需求清单”、“接口访问域名/IP与端口映射表”、“服务启停与健康检查命令集”、“日志文件结构与错误码解读”。
• 安全强调点：必须包含“防火墙策略配置建议”、“内网证书管理与HTTPS配置”、“访问密钥（AK/SK）的本地化生成与轮换机制”、“数据库连接的安全隔离方案”。

风格方向

• 视觉风格：采用深色系（如深蓝/炭灰）与科技感亮色（如青色/蓝色）搭配的配色方案，体现专业与稳定感。版式应严谨、模块清晰，留有充足的代码块和图表空间。
• 文档语气：冷静、精确、无歧义。使用主动语态和肯定句，避免模糊词汇。以“必须”、“确保”、“验证”等词强调关键步骤。
• 信息密度：高密度干货，避免冗余叙述。采用分级标题、编号列表、表格、流程图等形式高效组织信息。

构图建议（文档结构视觉化）

• 封面/首页：突出产品Logo、文档副标题“私有化部署专版”及版本号，背景可融入抽象的网络节点或服务器机架轮廓线稿。
• 文档结构图：在开头提供清晰的思维导图或流程图，展示“环境准备 -> 部署安装 -> 配置调优 -> 运维监控”四大核心阶段。
• 技术图示：使用标准UML部署图或带有机柜、服务器、交换机、防火墙图标的网络拓扑图，明确标出数据流向（实线/虚线区分）与关键配置点。
• 代码与命令区块：使用等宽字体、特定背景色突出显示所有命令行、配置文件片段，并附有行号以便于沟通定位。

细节强化

• 环境差异说明：明确区分基于物理机、VMware/KVM虚拟化、以及国产化信创环境下的不同配置项。
• 参数表格：所有可配置参数（如JVM参数、数据库连接池参数）应以表格形式列出，包含参数名、默认值、建议范围、修改影响说明。
• 故障排查树：针对“服务无法启动”、“接口调用超时”、“数据库连接失败”等常见问题，提供决策树状或步骤化的排查路径。
• 版本关联：在文档页眉或附录中，明确标注本版本文档所适配的产品核心版本、中间件版本及操作系统版本。

使用建议

• 生成初稿后，务必在模拟的隔离测试环境中，严格按照文档步骤进行“盲测”，以发现缺失或顺序错误。
• 将“核心提示词”中的模块作为文档编写的检查清单（Checklist），确保每个模块内容都已涵盖且深度一致。
• 针对不同技术水平的阅读者，可考虑产出“快速部署版”（仅包含最简必须步骤）和“完全配置版”（包含所有高级选项与原理说明）两种颗粒度的文档。
• 文档内所有涉及IP、域名、账号密码的位置，使用{PLACEHOLDER}（占位符）明确标出，并在前言中统一说明替换规则。