接手一个没人维护的模块,直接让它改代码是灾难。
先让它只读,产出一份说明:
- 这个模块对外提供什么(接口清单)
- 内部怎么组织的(关键类和数据流)
- 有哪些看起来奇怪的写法(可能的坑)
- 哪些地方没有测试覆盖
产出之后我对照代码核一遍,纠正它的误解。这份文档成为后续所有改动的基础。
价值:它读代码的速度比我快,但理解可能错。让它先输出理解,我纠错,比让它直接改安全得多。
这份说明顺便就是交接文档。
主楼- 暂无回复
继续逛逛
接手一个没人维护的模块,直接让它改代码是灾难。
先让它只读,产出一份说明:
产出之后我对照代码核一遍,纠正它的误解。这份文档成为后续所有改动的基础。
价值:它读代码的速度比我快,但理解可能错。让它先输出理解,我纠错,比让它直接改安全得多。
这份说明顺便就是交接文档。