通俗易懂

通俗易懂#

基本原则#

技术文档写作应避免使用以下类型词汇：

  • 行话黑话/领域术语（如：魔改、降级、熔断）

  • 网络流行语（如：墙裂、童鞋们）

  • 未解释的英文缩写（如：SRE/RCA/SLA）

典型案例#

技术领域缩略语#

<!-- 错误示例 -->
请TW协助SRE团队完成K8s集群的RCA分析

<!-- 正确示例 -->
请技术文档工程师协助网站可靠性工程团队完成Kubernetes集群的根因分析

运维领域行话#

<!-- 错误示例 -->
当 P0 故障 MTTR 超过 SLA 时，需进行 RCA

<!-- 正确示例 -->
当最高优先级故障的平均修复时间超过服务等级协议时，需进行根本原因分析
目录