技术文档目录,新人熟悉一个新系统

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/fei33423/article/details/79762540

对应的另外一篇文章,重构系统 https://blog.csdn.net/fei33423/article/details/75417317

1. 系统角色,系统边界图。核心流程拓扑图。核心用例把握。

2. 内部模块图。

3. 整体架构图,含支撑工具,中间件(所有依赖的系统)

3. 模块流程拓扑图,复杂版,含各个线路。

4. 线上部署机房图。

5. 各系统的机器逻辑图。

6. 真正的落地,代码和用例结合。特别是关注type值。

7. 熟悉表结构,type值,status值

类型
接口名
核心type值
调用方
场景描述

8. 熟悉表结构,type值,status值

涉及到的表,存储,mq,其他外部系统。链路图。


9. 接口对比学习
会议发起者调用离开会议的statusChange和发起controller的terminal会议的区别
10. 业务操作和入口日志对比
  1. 接口和实际行为对应学习,模拟端上操作,然后看结果。
11. bug 排查 【日志入口文件,和输出文件是排查的基础,dao,redis,日志基础框架建设,traceId mdc。】

12. 系统的优化改造:

   1. 基础日志改造

   2. 更新接口改造。 status的值得封装。不要直接业务上大方法上直接传入一个bean进来。

3. status的utils,type的接口化改造。

4. 各中间件的边界日志,整理到对应的文件中。方便后续制定方位排查。边界可维护

5. 单测框架改造。继承,自动化mock,非继承mock

13. 业务域的抽象。

展开阅读全文

没有更多推荐了,返回首页