service-review

服务文档模板

备注：

• 模板中并非每一项都要填写，根据服务特点和已掌握数据填写。

• 每个服务文档需要其负责人持续维护更新，以便服务模块重新分工的时候他人能够快速接手，同时对此模块感兴趣的人也能够通过此文档来进行了解。

以下是模板内容：

---

主负责人： 辅负责人：

介绍

（介绍业务背景和服务在业务背景下所承担的作用）

相关链接

（相关文档、技术方案、UI页面等有用链接）

整体架构

（服务的整体架构，数据如何流转，组件如何协同工作）

架构总览

核心功能

核心流程

数据模型

开发指南

（一名新同事该如何对此服务进行开发测试和部署）

开发

测试

部署

监控报警

（该服务有哪些监控报警）

性能分析

（该服务的性能测试，长期来看哪些地方可能会成为性能瓶颈，该如何解决）

运维费用

（基础设施费用，如机器、队列、数据库等）

遗留缺陷

（该服务有哪些缺陷、可优化点）

历史问题

（该服务曾经出现过哪些比较严重的问题）

FAQ

1.如果此服务出现最坏情况——宕机，会影响到哪些服务、哪些业务，怎么影响？

2.如果服务出现问题，如何第一时间发现？

3.XXX（自行或他人提问）