将项目处理给另一个开发人员的良好实践

Question

在将项目交给另一位开发人员时，如果最初的开发人员仍然需要几个月的时间来帮助过渡，那么有哪些好的程序可以遵循？如果需要一个具体的例子，我们假设一个中型Web应用程序。

Answer 1

作为一名初级开发人员，我已经分配了几个由他人编写的维护项目。我相信最容易继续的项目是代码干净且文档齐全的文档（有意义的var名称和格式也是如此），结构相对严格，开发人员花了一些时间写一些关于组件使用的注释。在Java中，这将包括类级别的javadoc;在其他语言中，它可能在源代码的顶部包含一个标题。

此外，如果最初的开发人员可以使用并且可以接受问题，那么它可以使学习更简单 - 不会让他感到困惑。

Answer 2

我一直在两端。接管代码库并将其交付。

你应该：

• 识别不完整的区域 明显。所以，如果你有一个目录 称为“xml”，但你所有的闪光灯 对象从中获取数据 你应该记录“flash / swfs / xml” 这一点。
• 识别数据库的哪些部分 不再使用。如果有 那些根本没用的桌子 了。
• 确定关注的领域，例如 某些页面的速度/性能。
• 如果你有一些真的倒退 某些页面上的逻辑，解释原因， 如果它没有被评论 代码直接。
• 任何第三方供应商都应该 确定及其成本和 在网站上使用。所以，如果你正在使用 一个传送网络来流式传输您的 flash视频，绝对让它成为现实 已知的。
• 如果你还有页面 项目，但没有被使用 识别它们，或简单地识别它们 删除它们。
• 如果你知道你的事实 数据库设计不佳， 不包含任何约束或索引 许多都没有主键 桌子，提一下。它会让 新开发者知道他们需要 优化数据库。
• 如果你硬编码了电子邮件地址 在代码内并没有把它们 在.config文件中，将其标识为 好。

我确信还有更多，但我希望有一些事情让我注意到我曾经接管过的一个项目。

Answer 3

如果您从一开始就编写了代码，使其设计合理且易于理解，并提供了足够的文档，那么过渡问题应该是最小的。

但培训总是很好。

Answer 4

对于任何需要构建环境的东西（某些编译器，第三方库，开源库，路径等），让原始开发人员与新开发人员坐在新开发人员的工作站上，然后浏览进行简单更改，承诺源代码控制，构建，冒烟测试等的过程。许多次超出主流的项目可能有奇怪的测试程序，或者它们可能来自不熟悉的存储库分支，可能需要特定的编译器版本，库等。可能会以不同的方式跟踪错误，可能需要特定的登录或端点进行测试等。通过在工作站上遍历流程，您将发现所有这些问题，拯救新的开发者很多挫折。