version: "1.0.0" name: vibe-deploy description: Use this skill to create deployment and operations documentation.

部署与运维文档制作工作流

1. 基本信息

• 名称：部署与运维文档制作工作流
• 目标：了解和记录现有项目的启动部署流程，包括部署流程、CI/CD、回滚方案、监控告警、日志位置等实际情况

2. 前置步骤

产物检查

1. 检查项目结构：

• 确认项目的基本结构和技术栈
• 检查是否存在现有的部署相关配置文件

1. 检查依赖项：

• 确认项目的依赖管理方式
• 检查是否有CI/CD配置文件

依赖项确认

1. 技术栈确认：

• 确认前端、后端使用的技术栈
• 确认数据库类型和版本
• 确认部署环境要求

1. 现有配置检查：

• 检查是否有Dockerfile、docker-compose.yml等容器化配置
• 检查是否有CI/CD配置文件（如.gitlab-ci.yml、Jenkinsfile等）
• 检查是否有环境配置文件

3. 执行步骤

第一步：项目分析与信息收集

1. 项目结构分析：

• 分析项目的目录结构
• 识别核心组件和服务
• 了解项目的部署架构

1. 技术栈确认：

• 确认前端技术栈（如React、Vue等）
• 确认后端技术栈（如Node.js、Java、Python等）
• 确认数据库类型（如MySQL、MongoDB、Redis等）
• 确认中间件和依赖服务

1. 现有配置检查：

• 检查Docker相关配置
• 检查CI/CD配置
• 检查环境变量配置
• 检查网络和端口配置

第二步：部署流程分析

1. 环境准备：

• 记录服务器配置要求
• 记录网络环境配置
• 记录依赖安装步骤

1. 部署步骤：

• 记录前端部署流程
• 记录后端部署流程
• 记录数据库部署和初始化
• 记录服务启动顺序

1. 环境变量配置：

• 记录生产环境配置
• 记录测试环境配置
• 记录开发环境配置

第三步：CI/CD流程分析

1. CI流程：

• 记录代码检查步骤
• 记录构建流程
• 记录测试流程

1. CD流程：

• 记录部署策略
• 记录自动部署触发条件
• 记录部署验证步骤

1. CI/CD配置：

• 记录配置文件内容
• 记录环境变量管理
• 记录构建产物管理

第四步：回滚方案分析

1. 回滚策略：

• 记录版本管理策略
• 记录回滚触发条件
• 记录回滚步骤

1. 回滚验证：

• 记录回滚后的验证步骤
• 记录服务可用性检查

1. 回滚演练：

• 记录定期回滚演练计划
• 记录演练流程

第五步：监控告警分析

1. 监控指标：

• 记录系统资源监控（CPU、内存、磁盘、网络）
• 记录应用性能监控
• 记录数据库监控
• 记录服务可用性监控

1. 告警机制：

• 记录告警阈值设置
• 记录告警通知渠道
• 记录告警处理流程

1. 监控工具：

• 记录监控工具选型
• 记录工具配置
• 记录监控面板设计

第六步：日志管理分析

1. 日志位置：

• 记录前端日志位置
• 记录后端日志位置
• 记录数据库日志位置
• 记录系统日志位置

1. 日志格式：

• 记录日志格式规范
• 记录日志级别设置

1. 日志分析：

• 记录日志收集方案
• 记录日志分析工具
• 记录日志保留策略

第七步：文档编写与整合

1. 文档结构：

• 设计部署与运维文档结构
• 章节划分

1. 内容编写：

• 按照实际情况编写详细内容
• 确保内容完整覆盖所有要求
• 提供清晰的步骤说明

1. 文档审核：

• 内容准确性检查
• 流程完整性检查
• 格式规范检查

4. 执行建议

1. 深入了解项目：在编写文档前，充分了解项目的技术栈、架构和现有的部署流程
2. 注重细节：详细记录每个步骤和配置，确保文档的准确性
3. 保持一致性：确保文档中的术语和流程与项目实际情况一致
4. 实际验证：按照记录的步骤进行实际操作验证，确保流程的可操作性
5. 定期更新：部署与运维文档应随着项目的发展定期更新
6. 提供示例：为关键配置和命令提供示例，方便用户理解
7. 与团队沟通：与项目团队保持沟通，确保记录的信息准确无误

5. 成功标准

1. 文档完整覆盖现有项目的部署流程、CI/CD、回滚方案、监控告警、日志位置等内容
2. 文档内容准确反映项目的实际情况
3. 文档格式规范，结构清晰，易于理解
4. 按照文档步骤能够成功完成部署和运维操作
5. 文档保存至指定位置：/项目文档/启动文档/部署与运维文档.md

6. 失败处理

1. 信息收集不足：如果项目信息收集不完整，应及时与项目团队沟通获取更多信息
2. 技术栈不明确：如果项目技术栈不明确，应通过代码分析和配置文件检查确定
3. 配置缺失：如果缺少必要的配置文件，应记录实际情况并与团队沟通
4. 文档编写错误：如果发现文档内容有误，应及时修正并重新审核

7. 输出成果

1. 部署与运维文档（部署与运维文档.md） - 保存至/项目文档/启动文档/目录

• 包含现有的部署流程
• 包含现有的CI/CD配置和流程
• 包含现有的回滚方案
• 包含现有的监控告警设置
• 包含现有的日志位置和管理

1. 相关配置示例：

• 实际的Docker配置示例
• 实际的CI/CD配置示例
• 实际的监控配置示例

1. 操作指南：

• 实际的部署操作步骤
• 实际的回滚操作步骤
• 实际的监控告警处理步骤

记住，部署与运维文档是项目稳定运行的重要保障，应确保文档的准确性、完整性和可操作性，为项目的部署和维护提供清晰的指导。