documentation - 离开公司时记录代码

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

3年前关闭。




Improve this question




我昨天从目前的工作地点辞职，我自己负责记录我的项目，以便我可以轻松地将它们移交。

请记住，我的代码已经按照良好的标准进行了注释，我还应该组合什么来帮助我的开发人员同事接管我的项目？

Answer 1

当使用其他人编写的新代码时，新人(或女孩)缺乏的第一件事就是对系统的概述。那里有哪些子系统，它们的目的是什么，以及应该在哪里完成手头的给定任务，这些都是浮现在脑海中的一些问题。

一份简明的起始文档，解释整个系统设计(以及为什么选择这种设计的原因)，也许带有一些图表，在处理由其他人编写的软件时，我会非常高兴得到。