| name | deployment-plan |
| description | 生成部署方案、部署手册、运维方案。当用户需要编写部署方案、部署手册、运维手册、环境配置方案、上线方案时使用此skill。 |
部署方案生成规范
适用场景
- 系统部署方案
- 部署操作手册
- 运维保障方案
- 环境配置方案
- 上线切换方案
- 灾备恢复方案
与相关文档的区别
| 文档类型 | 侧重点 | 读者 |
|---|
| 技术规格说明书 | 怎么设计 | 开发人员 |
| 部署方案 | 怎么部署 | 运维人员 |
| 运维手册 | 怎么运维 | 运维人员 |
| 用户操作手册 | 怎么使用 | 最终用户 |
文档结构规范
部署方案标准结构
1 概述
1.1 编写目的
1.2 部署范围
1.3 部署目标
2 部署环境
2.1 硬件环境
2.2 软件环境
2.3 网络环境
3 部署架构
3.1 架构设计
3.2 组件清单
3.3 网络拓扑
4 部署准备
4.1 环境准备
4.2 软件安装
4.3 配置准备
5 部署步骤
5.1 数据库部署
5.2 后端服务部署
5.3 前端部署
5.4 小程序发布
6 部署验证
6.1 功能验证
6.2 性能验证
6.3 监控配置
7 回滚方案
8 运维保障
附录A 配置清单
附录B 联系人清单
写作要求
部署方案写作原则
- 可操作性:步骤详细,可直接执行
- 完整性:覆盖所有部署环节
- 可回滚:提供回滚方案
- 可验证:每步部署后有验证方法
命令格式
$ 命令内容
配置文件格式
key: value
代码示例
"""部署方案生成模板"""
from docx import Document
from docx.shared import Pt, Cm
from docx.oxml.ns import qn
from docx.oxml import OxmlElement
def gen_deployment_plan(output_path):
doc = Document()
doc.add_heading('1 概述', level=1)
doc.add_heading('1.1 编写目的', level=2)
doc.add_heading('2 部署环境', level=1)
doc.add_heading('2.1 硬件环境', level=2)
doc.add_heading('3 部署架构', level=1)
doc.add_heading('4 部署步骤', level=1)
doc.add_heading('5 部署验证', level=1)
doc.save(output_path)
if __name__ == '__main__':
gen_deployment_plan('deployment_plan.docx')