生产运营文档区(OPSDIR)— 听云(WCL)工作目录¶
目录编号:DOC-OPS-00 / OPSDIR 版本:V1.2 创建日期:2026-08-11 最近更新:2026-08-11 维护人:听云(WCL) / TL 关联文档:PMG、PJM §3.5 听云生产运维管理、GLY 术语表(WCL/WDE/OWLG/OPSDIR)、WCL 听云工作手册、听码 WDE 工作目录、OWLG 工作日志规范
一、目录定位¶
本目录是项目级生产运营文档区,由听云(Weaver Cloud Listener,WCL)维护,承担本项目全部子项目(DIP1 / 未来 DIP2 / ...)的生产环境运维和客服工作。
管理依据:本目录的定位、公开/私有划分原则、Git 策略、工作日志机制详见 PJM §3.5 听云生产运维管理。术语定义见 GLY(OPSDIR 生产运营文档区 / WCL 听云 / OWLG 听云工作日志)。听云工作手册见 WCL-听云工作手册.md。
1.1 与听码(WDE)的分工¶
| 角色 | 职责 | 工作目录 |
|---|---|---|
| 听云 WCL | 生产环境部署、运维、客服、外部服务集成 | ops/(本目录) |
| 听码 WDE | 代码开发、测试、Bug 修复 | dip1/(或未来其他子项目目录) |
1.2 目录结构¶
ops/ # 听云工作目录
├── README.md # 本文件(目录索引)
├── WCL-听云工作手册.md # 听云角色定义和工作机制
├── public/ # 可公开发布文档(无密钥/账号)
│ ├── README.md # 公开文档索引
│ └── dip1/ # DIP1 相关公开文档
│ ├── DIP1-OPS-生产环境管理员操作手册.md
│ └── DIP1-EXT-外部服务集成指南.md
├── private/ # 不可公开发布文档(含密钥/账号/部署细节)
│ ├── README.md # 私有文档索引
│ └── dip1/ # DIP1 相关私有文档
│ ├── DIP1-生产环境部署完成报告.md
│ └── DIP1-生产环境部署上线准备.md
└── worklog/ # 听云工作日志(OWLG-YYYYMMDD-NN)
└── README.md # 工作日志规范与索引
1.3 目录结构图(Mermaid)¶
下图可视化展示
ops/目录的文档层级,按颜色区分:🟢 可公开发布 / 🔴 不可公开发布 / 🔵 工作日志 / 🟡 核心文档。
graph TD
OPS_ROOT["📂 ops/<br/>听云WCL工作目录<br/>DOC-OPS-00"]
OPS_ROOT --> OPS_README["📄 README.md<br/>目录索引 V1.1"]
OPS_ROOT --> OPS_WCL["📄 WCL-听云工作手册.md<br/>DOC-OPS-01 V1.1"]
OPS_ROOT --> OPS_PUB["📂 public/<br/>可公开发布 ✅"]
OPS_ROOT --> OPS_PRI["📂 private/<br/>不可公开发布 ❌"]
OPS_ROOT --> OPS_WLG["📂 worklog/<br/>听云工作日志 🔵"]
OPS_PUB --> OPS_PUB_README["📄 README.md<br/>公开文档索引"]
OPS_PUB --> OPS_PUB_DIP1["📂 dip1/<br/>DIP1 公开文档"]
OPS_PUB_DIP1 --> OPS_D1_OPS["📄 DIP1-OPS-生产环境管理员操作手册.md<br/>DOC-OPS-D1 V1.0"]
OPS_PUB_DIP1 --> OPS_D1_EXT["📄 DIP1-EXT-外部服务集成指南.md<br/>DOC-OPS-D2 V1.0"]
OPS_PRI --> OPS_PRI_README["📄 README.md<br/>私有文档索引 ⚠️"]
OPS_PRI --> OPS_PRI_DIP1["📂 dip1/<br/>DIP1 私有文档 ⚠️"]
OPS_PRI_DIP1 --> OPS_D1_DPLR["📄 DIP1-生产环境部署完成报告.md<br/>DOC-OPS-D3 V1.0 ⚠️"]
OPS_PRI_DIP1 --> OPS_D1_DPLP["📄 DIP1-生产环境部署上线准备.md<br/>DOC-OPS-D4 V1.0 ⚠️"]
OPS_WLG --> OPS_WLG_README["📄 README.md<br/>OWLG 工作日志规范 V1.0<br/>DOC-OPS-W"]
classDef root fill:#D4AF78,stroke:#004046,color:#004046,stroke-width:2px;
classDef core fill:#F2F0EB,stroke:#004046,color:#004046,stroke-width:1px;
classDef pub fill:#2a9d8f,stroke:#004046,color:#fff,stroke-width:1px;
classDef pri fill:#e76f51,stroke:#004046,color:#fff,stroke-width:1px;
classDef wlg fill:#457b9d,stroke:#004046,color:#fff,stroke-width:1px;
class OPS_ROOT root;
class OPS_README,OPS_WCL core;
class OPS_PUB,OPS_PUB_README,OPS_PUB_DIP1,OPS_D1_OPS,OPS_D1_EXT pub;
class OPS_PRI,OPS_PRI_README,OPS_PRI_DIP1,OPS_D1_DPLR,OPS_D1_DPLP pri;
class OPS_WLG,OPS_WLG_README wlg;
图例说明:
| 颜色 | 类别 | 同步公开仓 | 说明 |
|---|---|---|---|
| 🟡 金色 | 核心文档 | ✅ | 目录索引、听云工作手册 |
| 🟢 绿色 | 可公开发布 | ✅ | 无密钥/账号,可同步至 hk2026-docs |
| 🔴 红色 | 不可公开发布 | ❌ | 含密钥/账号/部署细节,仅私有主仓 |
| 🔵 蓝色 | 工作日志 | ❌ | OWLG 编号,仅私有主仓 |
二、文档导航¶
2.1 核心文档¶
| 文档 | 路径 | 说明 |
|---|---|---|
| 听云工作手册 | WCL-听云工作手册.md | 角色定义、职责、协作机制、反馈状态机、操作红线 |
| 工作日志规范 | worklog/README.md | OWLG 编号体系、记录规范、反馈子模板 |
2.2 可公开发布文档(public/)¶
可同步至公开文档仓(hk2026-docs),供互联网访问阅读。
| 子项目 | 文档 | 说明 |
|---|---|---|
| DIP1 | 生产环境管理员操作手册 | 系统架构、快速开始、环境变量、数据库管理、日志、故障排查 |
| DIP1 | 外部服务集成指南 | Cloudflare R2、WhatsApp Business API、前端三端部署 |
2.3 不可公开发布文档(private/)¶
⚠️ 仅内部可见,严禁同步至公开文档仓。
| 子项目 | 文档 | 说明 | 敏感内容 |
|---|---|---|---|
| DIP1 | 生产环境部署完成报告 | 部署过程、配置变更、验证结果 | 含配置细节、端口、服务状态 |
| DIP1 | 生产环境部署上线准备 | 部署前配置清单 | 含环境变量配置项 |
2.4 工作日志(worklog/)¶
听云(WCL)生产运维工作日志,编号体系
OWLG-YYYYMMDD-NN。
三、公开/私有文档划分原则¶
| 类别 | 判定标准 | 存放位置 | Git 同步策略 |
|---|---|---|---|
| 可公开 | 不含密钥、账号、密码、内部 IP、部署细节 | ops/public/ |
✅ 同步至公开文档仓 |
| 不可公开 | 含密钥、账号、密码、内部 IP、部署细节、凭据 | ops/private/ |
❌ 仅主仓私有,不同步 |
四、Git 策略¶
本章节对齐 PJM §4.3.1 仓库清单 + §4.3.4 版本控制范围 + §4.3.6 公开文档同步 + §3.5.5 升级与越权防护。
4.1 版本控制¶
ops/目录纳入主仓库(hk2026 私有仓)Git 管理ops/public/可同步至公开文档仓(hk2026-docs)ops/private/严禁同步至公开文档仓- 生产环境真实凭据文件(
.env.prod.local、*.key、*.pem)严禁纳入 Git,由 TL 本地保管
4.2 分支策略¶
遵循 PJM §4.3.2 轻量 Git Flow:
- 日常运维文档变更在 dev 分支
- 较大变更使用 feature/ops- 前缀分支
4.3 听云 Git 操作约束¶
与听码(WDE)相同,听云严禁执行 git commit / git push,所有 Git 操作由 TL 统一执行。详见 PJM §3.5.5 升级与越权防护机制。
五、修订记录¶
| 版本 | 日期 | 修订人 | 修订内容 |
|---|---|---|---|
| V1.0 | 2026-08-11 | DT | 初始化生产运营文档区;创建听云工作目录;迁移 DIP1 生产环境文档(区分公开/私有);创建工作日志规范 |
| V1.1 | 2026-08-11 | DT | PJM/GLY 引用对齐:① 标题从「OPS」调整为「OPSDIR」(与 GLY 术语表 OPSDIR 一致,避免与运营服务 OPS 混淆);目录编号从 OPS 调整为 DOC-OPS-00/OPSDIR;② 关联文档新增 PJM §3.5 + GLY 术语表 + OWLG 工作日志规范;③ §一 目录定位新增「管理依据」引用 PJM §3.5 + GLY;④ §四 Git 策略各小节新增 PJM 条款引用(§4.3.1/§4.3.2/§4.3.4/§4.3.6/§3.5.5)+ 凭据文件排除说明 |
| V1.2 | 2026-08-11 | DT | 新增 §1.3 目录结构图(Mermaid):可视化展示 ops/ 目录文档层级,4 色区分(🟡核心/🟢可公开/🔴不可公开/🔵工作日志)+ 图例说明表,方便快速理解文档层级和公开/私有划分 |
本目录为听云(WCL)工作目录,负责本项目全部子项目的生产环境运维和客服工作。管理依据见 PJM §3.5,术语定义见 GLY。