您应该为继任者留下什么？

假设您是唯一一名辞职的开发人员。您应该在代码本身之外创建什么样的信息/材料并留下来替换？

显而易见的答案是“肯定会想得到一份新工作”，但是距我开始新工作已经有一段时间了，而我忘记了当时最需要的最重要的东西。

我在想：

• 帐号/密码
• 设备，备份，软件CD的位置

还有什么？

• 帐号和密码
• 服务器信息
• 好代码
• 文献资料
  • 数据库图和说明很棒
  • 代码中的奇数清单
• 程序
• 人工过程或偶尔的非显而易见的工作的解释
• 他们使用或发现有帮助的程序列表
• 联系信息 ;）

一杯浓咖啡和道歉记录。

是我希望我离开的一切。

• 文档。写下一些评论有多难？构建说明，部署说明，移动系统说明。重新启动后一切都消失了该怎么办。
• 文件。写出为什么要用这种方式做，这样我就不必怀疑为什么你没有用另一种方式做。备份系统如何工作，服务器如何响应负载，测试，测试用例和用例。
• 笔记。“使用数据库时，永远不要说SELECT * FROM clients。我们不确定为什么，但是它会转储数据库”。

我的电子邮件地址，甚至电话号码。

以我的经验，很难记下每个细节，因此，如果您的继任者需要更多信息，最好的方法是（在一定程度上）可用。

您编写的程序的文档，例如它们的用途，用于将来开发的源文件的位置，密码等。

这可以作为注释在代码内，也可以在外部查看。

我不仅想了解文档，还想知道为什么某些决定是在做出决定时做出的。我们当前在一个项目上使用SWIG，其他开发人员之一想知道为什么我们不使用Boost :: Python。一个简单的答案是客户当时不允许使用Boost。现在是一个不同的故事。

这样的事情不仅可以帮助他们理解项目，还可以帮助您克服实施过程中的哪些限制/约束/挑战。这将为他们提供将来维护和功能增强的起点。

我没有看到其他人提到的一件事（尽管我可能忽略了它）是记录如何设置开发环境。我意识到大多数情况下，它只是安装一些东西，获取最新信息，进行编译就可以了。但是，有时还有更多的事情（SharePoint是我想到的一种情况），并记录必须以哪种方式配置什么通量电容器，这对于跟随您的可怜人非常有帮助。

如果它是一个桌面程序，如何从头开始构建整个系统（可能是几个单独的程序），如何创建一个用于分发的程序包（它具有什么依赖性，例如.NET版本），以及如何将其部署到服务器上下载（如果适用），或将其刻录到CD或DVD。

如果是基于Web的程序，则对服务器的FTP和（如果适用）SSH访问以及使用哪些工具在本地创建和测试代码。

如果是嵌入式系统，请完整说明如何构建二进制映像，使用了哪些工具，如何将代码下载和刷新到产品中，如何在设备上设置文件系统（如果有）。

我最近刚在与您类似的情况下离职（我不是唯一的开发人员，但实际上我们只有两个人，所以我对其他人没有的很多了解（反之亦然，当然））。

在常规文档方面，记录整个系统的概述很重要。各个组件已经在代码中记录了下来，但是组件之间的交互以及这样做的原因或为什么需要与该组件进行对话很重要，而且仅通过调试/查看代码并不总是很容易找出来。

然后，大约一个月在我离开之前，我每次做的东西，只有我的时间可以做什么，我写下了到底发生了什么，我不得不这样做，为什么。通常是这样的情况：“ xyz组件中有一个错误，要修复它，我知道因为X会在文件abc中查找，然后我必须执行此操作。”

当然，我留下了我的电子邮件地址和电话号码，以防万一出现无法自己解决的问题。在最初的几周里，我接到了几个电话，但它们却逐渐减少。

我们都想要一个完整的系统数据流程图，其中包含功能需求列表。最初编写系统时，很可能从未获得过！像大多数地方一样，最好的文档可能是代码本身，所以我最喜欢的是文档齐全的代码。代码中的注释行和注释行解释了您在技术上和功能上都在尝试做什么。

对于文档的＃1规则不是什么它做，但为什么。什么是运行程序的背景知识，它们做什么？

我认为除了平常的文档之外，我希望在文档中看到的是遗漏的功能。就像为什么某些想法是不执行或某一个平台或方法不使用（这是另有一个显而易见的选择）。

这样可以确保后继者始终知道该做什么，或者如果他更有能力，那么他也许可以提出解决办法并使某些功能正常工作。

这尤其适用于开源项目。可以节省大量时间和脑力！