结构化BI报表私有化部署文档提示词

角色定义与任务定位

请以“资深技术文档工程师”与“私有化部署方案架构师”的双重身份，执行本次内容生成任务。你的核心目标是：为“结构化BI报表私有化部署文档”创建一份逻辑严密、内容详实、可直接交付给客户或实施团队的专业版技术文档。这份文档需超越基础说明，体现部署方案的系统性、安全性与可维护性。

适用场景

• 为客户提供标准化的私有化部署方案说明书。
• 作为内部实施团队的标准作业流程（SOP）参考文档。
• 在项目招投标或售前阶段，展示产品的专业部署能力。
• 用于培训新入职的运维或实施工程师。

核心提示词

请基于以下结构化提示词框架，生成文档具体内容：

• 文档标题与版本：[客户名称] BI报表平台V[版本号] 私有化部署文档（专业版）
• 第一章：概述：阐述本次私有化部署的目标、范围、设计原则（如高可用、可扩展性）及文档阅读对象。
• 第二章：系统架构与部署拓扑：描述生产环境与测试环境的服务器拓扑图，明确各节点（应用服务器、数据库服务器、文件服务器、负载均衡器）的角色、配置要求（CPU/内存/磁盘/网络）及内部通信关系。
• 第三章：软硬件依赖与前置条件：详细列出操作系统版本、数据库版本（如MySQL 8.0+）、中间件（如Nginx, Redis）、JRE版本等软件依赖清单，以及防火墙端口开放清单。
• 第四章：部署步骤详解：按顺序提供：1) 基础环境初始化脚本示例；2) 数据库初始化与账号权限配置；3) 应用包部署、解压与目录结构说明；4) 核心配置文件（如application.yml）的关键参数修改指南；5) 服务启动、停止脚本及系统服务注册（systemd）方法。
• 第五章：配置与初始化：说明管理员账号初始化、许可证（License）激活、数据源连接配置、定时任务设置等首次使用必备操作。
• 第六章：监控、维护与故障排查：提供系统健康检查接口、日志文件目录与关键日志解读、日常备份策略（数据库备份、应用备份）、常见故障（如服务无法启动、报表生成失败）的诊断步骤与解决方案。
• 第七章：安全建议：明确账号密码策略、HTTPS配置建议、服务器安全加固（如关闭不必要的端口、定期更新补丁）及数据加密传输要求。
• 附录：包含术语表、修订记录、部署检查清单（Checklist）。

风格方向

• 文体风格：采用正式、客观、精准的技术文档风格，避免口语化和营销性词汇。
• 结构层次：严格遵循“章-节-点”的多级标题结构，确保逻辑递进清晰。
• 表述方式：多使用指令性、陈述性语句，如“执行以下命令”、“修改X参数的值为Y”、“确保Z条件满足”。

构图建议

（此处的“构图”指文档内容的结构排布与可视化元素规划）

• 图表结合：在系统架构、部署拓扑、数据流等部分，使用Mermaid或类似语法描述图表，并配以文字说明。
• 代码块高亮：所有命令行操作、脚本内容、配置文件片段，均需放入等宽字体的代码块中，并注明语言类型（如bash, yaml, sql）。
• 清单式列举：对于前置条件、检查项、故障现象，使用有序或无序列表呈现，增强可读性。
• 重点突出：对关键配置项、风险操作、重要注意事项，使用“注意”、“警告”等提示框进行强调。

细节强化

• 参数具体化：避免出现“配置数据库地址”这样的模糊描述，应写为“修改 `spring.datasource.url` 配置项，值为 `jdbc:mysql://192.168.1.100:3306/bi_report?useSSL=false&characterEncoding=utf8`”。
• 路径明确：所有文件路径均需给出绝对路径或相对于部署根目录的相对路径，如 `{DEPLOY_HOME}/bin/startup.sh`。
• 版本锁定：所有依赖的软件必须指明经过验证的具体版本号，例如“Redis 6.2.7”，而非“Redis 6.x”。
• 回滚方案：在关键部署步骤后，可简要说明回滚到上一步的操作方法，体现文档的周全性。

使用建议

• 生成文档时，请将提示词中的占位符（如[客户名称]、[版本号]）替换为实际项目信息。
• 可根据客户实际IT环境，在“第二章”和“第三章”中调整或增删服务器角色与依赖项。
• “第六章 故障排查”部分，建议结合产品已知常见问题库进行填充，使其更具实战价值。
• 最终输出前，请通读文档，确保从“环境准备”到“上线验证”的整个流程闭环，无逻辑断点。