Menu
生成运维手册、运维方案。当用户需要编写运维手册、运维方案、运维规范、故障处理手册时使用此skill。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
生成接口文档、API文档。当用户需要编写接口文档、API文档、接口规范文档时使用此skill。
生成中文软件项目规格文档（需求规格说明书、概要设计、详细设计）。使用python-docx生成符合国标的Word文档，包含封面、修订记录、目录、正文、附录等完整结构。当用户需要生成需求文档、设计文档、规格说明书时使用此skill。
生成测试计划、测试方案。当用户需要编写测试计划、测试方案、测试策略时使用此skill。
生成培训方案、培训计划。当用户需要编写培训方案、培训计划、培训资料时使用此skill。
生成验收报告、验收申请、项目总结。当用户需要编写验收报告、验收申请书、项目总结报告、交付物清单时使用此skill。
生成部署方案、部署手册、运维方案。当用户需要编写部署方案、部署手册、运维手册、环境配置方案、上线方案时使用此skill。
| name | ops-manual |
| description | 生成运维手册、运维方案。当用户需要编写运维手册、运维方案、运维规范、故障处理手册时使用此skill。 |
| 文档类型 | 侧重点 | 读者 |
|---|---|---|
| 技术规格说明书 | 怎么设计 | 开发人员 |
| 部署方案 | 怎么部署 | 运维人员 |
| 运维手册 | 怎么运维 | 运维人员 |
| 用户操作手册 | 怎么使用 | 最终用户 |
1 概述
1.1 编写目的
1.2 适用范围
2 系统架构
2.1 架构设计
2.2 组件清单
3 日常运维
3.1 系统巡检
3.2 数据备份
3.3 日志管理
3.4 性能监控
4 故障处理
4.1 故障分级
4.2 故障处理流程
4.3 常见故障处理
5 应急预案
6 运维规范
附录A 配置清单
附录B 联系方式
[单位名称] # 黑体 18pt，居中
[项目名称] # 黑体 18pt，居中
[文档标题] # 黑体 26pt，居中，加粗
[空行 × 6]
文档编号：XXX-XXX-XXX
版本号：V1.0
编制日期：YYYY年MM月DD日
密 级：内部
section.top_margin = Cm(2.54) # 上边距 2.54cm
section.bottom_margin = Cm(2.54) # 下边距 2.54cm
section.left_margin = Cm(3.17) # 左边距 3.17cm
section.right_margin = Cm(3.17) # 右边距 3.17cm
| 标题级别 | 字体 | 字号 | 对齐方式 |
|---|---|---|---|
| 一级标题 | 黑体 | 22pt（二号） | 左对齐 |
| 二级标题 | 黑体 | 16pt（三号） | 左对齐 |
| 三级标题 | 黑体 | 14pt（四号） | 左对齐 |
table.style = 'Table Grid' # 带边框表格
# 表头背景色
set_cell_shading(cell, 'D9E2F3') # 浅蓝色
# 命令说明
$ 命令内容
3.1 系统巡检
[1段文字说明巡检目的和频率]
巡检内容：
[表格展示巡检项、检查命令、正常标准、异常处理]
巡检命令：
[代码块展示巡检命令]
4.3 常见故障处理
[表格展示故障现象、可能原因、处理方法]
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""运维手册生成模板"""
from skills.utils import create_doc, add_cover, add_revision, add_toc, T, P, B
def gen_ops_manual(output_path):
doc = create_doc()
add_cover(doc, '运 维 手 册', {'文档编号：':'OM-YJZHDD-2024-001','版本号：':'V1.0','编制日期：':'2024年03月01日','密 级：':'内部'})
add_revision(doc)
add_toc(doc)
doc.add_heading('1 概述', level=1)
doc.add_heading('1.1 编写目的', level=2)
P(doc, '本文档是《应急指挥调度中心运维服务项目（2024-2025）》的运维手册，为运维人员提供系统日常运维、故障处理、应急响应等操作指导。')
doc.add_heading('1.2 适用范围', level=2)
P(doc, '本手册适用于系统运维人员、数据库管理员、网络管理员等技术人员。')
doc.save(output_path)
print(f'已生成：{output_path}')
if __name__ == '__main__':
gen_ops_manual('ops_manual.docx')
所有技能共享以下工具函数，统一从 skills.utils 导入：
| 函数名 | 说明 | 参数 |
|---|---|---|
create_doc() | 创建格式化文档对象 | 无 |
add_cover(doc, title, doc_info, unit_name, project_name) | 添加封面页 | doc:文档对象, title:文档标题, doc_info:信息字典 |
add_revision(doc) | 添加修订记录表 | doc:文档对象 |
add_toc(doc) | 添加目录页 | doc:文档对象 |
T(doc, headers, rows) | 创建表格 | headers:表头列表, rows:数据行列表 |
P(doc, text, style) | 添加段落 | text:文本内容, style:段落样式(可选) |
B(doc, text) | 添加加粗段落 | text:文本内容 |