离开公司时记录代码

djd*_*d87 16 documentation

我昨天辞去了我目前的工作地点,而且我正在自己记录我的项目,所以我可以轻松地将它们交给我.

请记住,我的代码已被评论为一个良好的标准,我还应该把其他什么组合起来帮助我的开发人员接管我的项目?

Mic*_*ent 20

当处理由其他人编写的新代码时,新人(或女孩)缺少的第一件事是对系统的概述.那里有哪些子系统,它们的目的是什么以及在哪里可以看到完成手头的特定任务是我想到的一些问题.

一个简明的起始文档,解释整个系统设计(以及为什么选择这个设计的原因)或许有一些图表,我会很高兴在处理由其他人编写的软件时获得.

  • 同意.坐下来想想你加入下一家公司时需要什么. (8认同)
  • 我添加了另一件事,(已知错误的另一个文档,但未解决) (5认同)

Eri*_*ens 5

我希望我在这里没有什么有用的话要说,但随着代码转让的接收者经历了几次低迷、技能重新平衡等,我想重复并在之前的答案中添加几点。

我假设您的管理层已任命一名或多名人员来接管您的工作。

你说无论如何你都不需要它,但是现在不是给代码添加注释的时候。

已经指出,软件的新所有者需要一个高层次的概述,该软件是做什么的以及需要做什么。保持简短,并尽量不要让它陷入“软件应该是什么样子”,不要费心从坟墓中重新构建系统。

然后转向实际问题:谁是利益相关者、测试人员以及曾经或可能参与并了解该软件的任何其他人。

其他文档和 PR 的要求在哪里? PR 中即将出现的要求有什么特别值得注意的吗?

软件在版本控制中的什么位置,所有的东西都在里面吗?真的吗?

构建软件需要什么?

最宝贵的时间将花在验证最后两点上:从版本控制重新创建完整的构建环境并从新所有者的计算机构建(测试/交付)。如果有时间,解决一个简单的问题。

祝你在新工作中一切顺利!