Python开发On-Prem私有化文档清晰框架提示词

角色定义与任务定位

请以“企业级Python技术架构师”的身份，运用本提示词方案。你的核心目标是：为即将部署在客户本地环境（On-Prem）的Python项目，生成一份结构清晰、内容详实、可直接指导实施与运维的私有化部署文档框架。这份文档应聚焦于实战应用，确保技术团队能据此顺利完成私有化环境的搭建、配置与维护。

适用场景

• 为To-B端软件产品或定制化项目编写私有化部署说明书。
• 构建内部工具或平台在隔离网络环境下的标准化部署指南。
• 准备项目交付物中，关于环境搭建、配置与运维的核心文档部分。
• 统一团队在私有化项目中的文档规范与知识沉淀格式。

核心提示词

以下提示词组合可直接用于生成文档初稿或指导文档大纲撰写：

• “撰写一份Python项目的On-Prem私有化部署方案，需包含：环境前置检查清单、依赖安装与隔离方案（推荐使用virtualenv或Docker）、配置文件详解与敏感信息管理、服务启动与守护进程配置、日常运维与监控指令、故障排查流程图。”
• “以Markdown格式，输出[项目名称]的私有化部署文档。章节需涵盖：1. 系统与软件依赖要求；2. 分步安装部署流程；3. 核心配置文件参数说明；4. 数据初始化与备份策略；5. 服务启停与健康检查；6. 常见问题与解决方案附录。”
• “生成一个聚焦安全与稳定的Python应用私有化部署框架，重点描述：网络端口规划、防火墙配置建议、服务账户权限设计、日志轮转与审计、基于Prometheus+Grafana的基础监控指标列表。”

风格方向

• 专业严谨：采用技术手册风格，语言准确、无歧义，避免口语化。
• 结构分明：文档层级清晰，使用规范的章节编号（如1.， 1.1， 1.1.1），便于查阅和引用。
• 面向操作：以“命令”、“步骤”、“检查点”为导向，提供可直接复制执行的代码块或命令序列。
• 视觉辅助：在提示词中可加入“使用流程图说明服务依赖关系”、“用表格对比不同部署模式的资源需求”等要求，以增强可读性。

构图建议（文档结构框架）

• 顶层设计：文档标题应明确包含项目名与“私有化部署文档”字样。摘要部分简述文档目标与范围。
• 逻辑递进：结构按“准备 -> 部署 -> 配置 -> 验证 -> 运维”的线性流程展开。
• 模块化章节：将大型配置拆分为独立章节，如“数据库配置”、“缓存服务配置”、“应用服务器配置”。
• 附录收尾：将变更记录、版本兼容性表、术语解释等补充内容置于附录，保持主体流程的简洁。

细节强化

• 环境变量：明确列出所有必需的环境变量及其示例值，并标注哪些为敏感信息。
• 路径规范：统一约定安装路径、数据目录、日志目录的绝对路径规范。
• 命令示例：所有命令行操作都应提供完整示例，并注释关键参数的含义。
• 验证步骤：在关键步骤后，提供具体的命令或操作以验证该步骤是否成功完成。
• 风险提示：在可能影响系统稳定性的操作前，加入明显的警告或注意事项。

使用建议

• 将“核心提示词”中的任意一条输入AI对话，即可生成一份结构完整的文档草稿。
• 生成后，请务必根据实际项目细节，替换其中的占位符（如[项目名称]）、检查命令的兼容性、并补充项目特有的配置项。
• 可结合“细节强化”中的要点，对生成文档的特定章节进行迭代优化，使其更贴合实际工程需求。
• 此框架提示词亦可用于检视现有文档的完备性，作为查漏补缺的检查清单使用。