1.3 KiB
1.3 KiB
文档模板（运营类）
在 docs/ 下添加新的运营或工程文档时使用此模板。
保留适用的部分；合并前删除不适用的占位符。
1. 摘要
- 目的： <一句话说明本文档存在的原因>
- 受众： <运维人员 | 评审者 | 贡献者 | 维护者>
- 范围： <本文档涵盖的内容>
- 非目标： <本文档有意不涵盖的内容>
2. 前置条件
- <所需环境>
- <所需权限>
- <所需工具/配置>
3. 操作流程
3.1 基线检查
- <步骤>
- <步骤>
3.2 主工作流
- <步骤>
- <步骤>
- <步骤>
3.3 验证
- <预期输出或成功信号>
- <验证命令/日志/检查点>
4. 安全、风险和回滚
- 风险表面： <可能受影响的组件>
- 故障模式： <可能出现的问题>
- 回滚计划： <具体的回滚命令/步骤>
5. 故障排除
- 症状： <错误/信号>
- 原因： <可能的原因>
- 修复： <操作>
6. 相关文档
- README.md — 文档分类和导航。
- <related-doc-1.md>
- <related-doc-2.md>
7. 维护说明
- 所有者： <团队/角色/领域>
- 更新触发条件： <哪些变更需要强制更新本文档>
- 最后审核：