专业版Python开发On-Prem私有化文档提示词
这是一份面向企业级Python开发者的提示词方案,旨在生成专业、结构化的On-Prem私有化部署文档。
Python开发
On-Prem
私有化文档
结构化
行业应用
提示词内容
可直接复制使用
角色定义与任务定位 请以“企业级技术文档架构师”的身份,专注于为需要进行私有化(On-Prem)部署的Python项目,生成一份专业、清晰、可直接用于内部实施与团队协作的部署与配置文档。你的核心目标是产出结构严谨、步骤明确、规避歧义的技术指南,确保交付物具备高度的实用性和行业适用性。 适用场景 为企业内部开发团队编写Python服务或应用的On-Prem部署手册。 为交付给客户的私有化软件产品提供配套安装、配置与运维文档。 在金融、医疗、政务等对数据安全与本地部署有严格要求的行业,撰写符合其规范的Python应用部署指南。 将复杂的云端部署流程适配并重构为适合本地服务器环境的结构化文档。 核心提示词 以下提示词组合可直接或稍作修改后使用,以生成目标文档: 作为技术文档架构师,撰写一份Python [项目名称/类型,如:数据分析平台] 的On-Prem私有化部署指南。 文档需严格遵循以下结构:1. 系统环境与前置依赖检查;2. 源码获取与目录结构说明;3. 依赖隔离与环境配置(使用virtualenv/conda);4. 核心服务配置详解(数据库、缓存、消息队列等);5. 应用初始化与启动脚本;6. 健康检查与运维监控点;7. 常见故障排查清单。 重点突出与公有云部署的差异点,包括网络配置、防火墙规则、本地镜像仓库使用、离线依赖安装等。 使用术语:On-Premises部署、私有化环境、最小权限原则、高可用架构(如适用)、备份与恢复策略。 风格方向 文体风格:采用正式、精准、无歧义的技术文档风格。避免营销性语言,以指令性、说明性语句为主。 视觉基调:文档排版应体现“结构化”与“清晰度”。设想为带有清晰层级标题、代码块高亮、表格化参数列表、流程图或架构图的专业PDF或Wiki页面。 色彩与质感:隐喻上,偏向于深色代码编辑器背景上的亮色代码高亮(如Monokai主题),或极简黑白灰搭配重点色(如蓝色)突出警告与关键步骤,体现专业与可靠感。 构图建议(文档结构隐喻) 全景镜头:文档开头应提供“部署架构总览图”和“文档阅读指南”,让用户对整体流程和文档构成有宏观认知。 分解镜头:将复杂流程分解为顺序或并行的模块章节,如“基础环境准备”、“核心服务部署”、“应用层配置”等,每个模块内部再采用步骤序列展开。 特写镜头:对关键命令、敏感配置项(如密钥、地址)、错误日志片段,使用独立的代码块或警告框进行突出展示,确保用户注意力聚焦。 细节强化 参数具体化:避免使用“YOUR_HOST”这样的占位符,示例中应使用符合私有化环境特征的示例值,如“192.168.1.100”、“internal.registry.company.com”。 环境区分:明确标注不同环境(开发、测试、生产)的配置差异,并提供配置模板或示例文件。 安全强化:融入安全最佳实践细节,如“使用Ansible Vault加密敏感变量”、“配置SSH密钥登录而非密码”、“设置基于角色的数据库访问权限”。 可操作性:为长命令提供解释注释,为可能失败的步骤提供验证命令(例如,在安装后运行 `python -c “import module”` 来验证)。 使用建议 在使用AI生成初稿后,务必由资深开发或运维人员进行审校,重点核对命令的准确性、路径的合规性及安全策略的有效性。 将“核心提示词”中的结构化要求作为生成时的固定指令,再结合具体项目的技术栈(如Django, FastAPI, Celery等)和基础设施(K8s, Docker Compose, 裸机)进行细化。 生成的文档应视为“活文档”,建议配套提供版本变更记录(Changelog)章节,并与项目的配置管理仓库(如Git)关联,确保文档随代码更新。 为提升团队协作效率,可在文档附录添加“团队职责分工参考”与“交付物检查清单”。