准备移交文件的最佳方法是什么？

Question

我们有一位开发人员在离开我们公司5年之后带走了他多年来拒绝记录的许多有用信息，管理层基本上对他的时间做了一些反应。

我们有开发者在他去之前的几个星期，并且有我们知道他需要记录的区域。但是，我们不确定是否应该让他自己记录文档（担心他会在4周内制作出低于标准的文档），还是我们让一些开发人员与他一起坐下来解释他所做的事情，然后离开记录给开发者的责任。这并不理想，因为这需要其他开发人员的时间。

敏捷公司如何处理这个问题？

Answer 1

避免在任何情况下将人员留在“角落”，因为写下“材料”的任务减少了，原因很简单，你冒着生产低质量产品的风险。

如果他是您的代码库中未记录的关键部分的持有者，则应该将其视为您的团队的首要任务。
白天至少有两个人与他互动（轮流）。当一位开发人员直接与你的离开同事交流时，其他人应该记录他们在你的内部合规媒体中所学到的内容（内联评论，wiki，docs ..）。
要完成此任务，请选择您的离职同事喜欢的&，尽可能在技术上应对。
我认为如果所有的工作都在你的同事的办公桌上完成，那么这是最好的。

由于您似乎知道自己错过了什么，因此您也可以尽可能准确地计划目标。首先尝试覆盖坚硬的部分。与离开的人讨论这个计划&住的开发者。

不惜一切代价避免紧张局势&请记住，你的离开男子只有一个坏的建议风险。

Answer 2

我们通常通过广泛的代码审查来完成这种类型的转换，尽管我们通常没有时间跨度长达5年的情况。作为一种标准做法，我们每周都会进行代码审查，并且在此期间，我们鼓励将代码中的文档作为代码注释或者需要在文档存储库中引用外部文档。通过定期进行检查（通常在每周开发冲刺结束时），如果有人在没有适当文件的情况下将我们留在项目中间，我们会将影响降到最低。

5年过去了很长一段时间，有人坐下来审核自己完成的核心工作并正确评论，这样可以生成自动文档（例如Java中的JavaDoc），这将是一个不错的第一步。因为他正在做实时代码审查，而不是稍后等待，那么做文档会更好，因为与他坐在一起的开发人员可能会忘记某些细节，并且不想使用大量时间（首先要审查以后再为这些开发者记录）。

根据代码量，您可能需要挑选需要审查的组件。开发人员应该能够优先考虑哪些组件是最重要的（例如核心算法），并且审核应该从那里开始并使用适当的组。

此外，如果您的公司有内部维基，您可以在其中添加条目并从代码文档本身引用它。

Answer 3

得到一些开发商与他同坐，他解释说他做了什么，

正确的。几乎没有其他办法。

这是一个广泛的配对编程，代码审查，监视和学习。

并不理想，因为这种从其他开发商

占用时间你想要的信息？如果是这样，那么你必须投入时间来收集它。

如果不是，那就不用担心。