专业版测试工程私有化部署文档提示词

角色定义与任务定位
请以资深测试工程专家兼技术文档架构师的身份，执行本次内容生成任务。你的核心目标是：为软件产品的“私有化部署”环节，创作一份面向实施工程师、运维人员及客户的专业、结构化、可执行部署文档。这份文档需超越基础操作说明，应具备清晰的流程逻辑、严谨的环境与依赖说明、可验证的检查点以及专业的排错指引。

适用场景

为企业级软件（如ERP、CRM、大数据平台、安全软件）编写私有化部署指南。
为测试团队提供部署环境搭建的标准操作流程（SOP），用于后续测试验证。
为客户技术团队交付清晰、可靠的部署手册，降低实施门槛与沟通成本。
作为知识库文档，结构化归档部署所需的资源配置、步骤与注意事项。


核心提示词
以下提示词组合可直接用于生成文档初稿或指导文档结构：

主干指令：撰写一份关于[产品名称]私有化部署的专业文档，目标读者是具备基础Linux和网络知识的实施工程师。文档需涵盖从环境准备、安装部署、配置调整到健康检查的全流程。
结构扩展：文档结构需包含：1. 部署概述与架构图；2. 软硬件环境清单与检查脚本；3. 分步安装命令与参数说明；4. 核心配置文件详解与修改示例；5. 服务启动、验证与监控方案；6. 常见故障排查清单。
内容强化：在每一步骤中，明确标注前提条件、执行命令（附注释）、预期输出结果。对于关键配置项，使用“ =  ”的格式进行说明。


风格方向

文体风格：采用技术手册的客观、精准、简洁风格。避免营销性语言，以指令性、说明性语句为主。
逻辑层次：文档应呈现清晰的阶梯式逻辑，遵循“先决条件 -> 执行动作 -> 验证输出”的循环。大量使用编号列表、子标题和表格来组织信息。
术语与一致性：严格统一专业术语（如使用“节点”而非“服务器”，“容器化部署”而非“docker安装”）。保持文件名、路径、变量名在全文中完全一致。


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

顶层架构图：在文档开头，使用文字或Mermaid语法描述部署组件（如数据库、应用服务器、负载均衡器、存储）之间的网络拓扑与数据流关系。
信息分层：像技术图纸一样分层呈现信息。第一层是阶段（准备、安装、配置、验证）；第二层是任务；第三层是具体步骤与代码块。
重点突出：对危险操作（如数据删除、防火墙关闭）、关键配置、必须修改的参数，采用“警告”或“重要”框进行视觉隔离强调。


细节强化

环境检查清单：提供可复制粘贴的Shell命令脚本块，用于检查操作系统版本、内核参数、磁盘空间、端口占用、依赖包版本等。
配置示例对比：给出默认配置片段与修改后的配置片段，并通过并排对比或差异高亮（使用diff格式）的方式展示改动点。
验证步骤量化：健康检查不应只说“检查服务是否正常”，而应提供具体的验证命令（如curl -f http://localhost:8080/health）及成功的预期返回结果（如{"status":"UP"}）。
故障树引导：在排查部分，使用“如果遇到现象A，则依次检查X、Y、Z”的决策树形式，引导读者快速定位问题。


使用建议

将“核心提示词”中的[产品名称]替换为实际产品名，并填充具体的版本号、端口号、路径等变量，即可作为生成完整文档的初始提示。
在实际撰写时，应优先完成“环境清单”和“分步安装命令”这两个最核心的模块，确保其可执行性，再扩展其他部分。
文档完成后，建议邀请一位不熟悉该项目的工程师进行试操作，根据其反馈补充缺失的前提说明或澄清模糊步骤，这是提升文档质量的关键。
本方案生成的文档内容，建议最终以PDF或静态网页形式发布，并保留源码（如Markdown格式）以便后续版本迭代。