我在一家小公司工作。在我被雇用之前，公司的软件开发部门由一个自学成才的工作人员组成。现在，我已经为公司编写软件了几年，我的任务是建立正式的公司范围内的软件开发实践。目前，除了

编写代码，对其进行测试，将其放入.zip文件中，然后将其发送给客户端。TDD和版本控制的加分。

我的老板要我写一份软件开发人员手册，该手册定义了我们用来完成工作的一般流程，协议，工具和指南。换句话说，他想要一本“这就是我们在这里所做的”书，以使新员工更容易熟悉我们的处事方式，并帮助我的老板了解他的奴才在做什么以及他们的工作方式它。

从我的角度来看，我正在奠定基础，并且需要正确完成。您将如何选择此类手册的主题？您可以提供一些示例主题吗？

旁注：如果重要，我们主要是Microsoft .NET商店。我们正在研究诸如XP和Scrum之类的敏捷实践，但我们可能必须对其进行大量修改以使其在我们公司中正常工作。

我会将其细分为

• 现有员工-名称和职称（最好带有照片）
• 应用程序，登录名，要知道的数据和已提交的许可请求
• 书签到公司站点和与业务相关的关键外部站点
• 公司用于通讯，电子邮件，会议室预订，共享屏幕的应用程序
• 公司相关活动的程序，例如费用收据，预订旅行
• 开发人员机器设置。详细描述设置新的开发人员计算机的过程。通常，“预计”只需要一天，但实际上通常需要3-5天。
• 开发过程，如何跟踪，分配和更新工作以及使用哪些工具。
• 如何测试，测试什么，何时测试，在哪里测试。
• 编码标准，包括文件命名约定和特定于语言的标准。
• 如何处理错误，在哪里进行记录，如何进行修复。
• 部署过程中，对于生产推送需要了解的关键事项是什么。
• 如何记录，记录什么，何时记录。
• 填充物的位置，例如代码，数据，标准，文档，链接和其他资产的位置。

使其模块化，还可以使您或其他人分别进行更新，例如，员工的姓名和职位会随着人们的来去而频繁变化。

对于每个部分，我都会尝试从“新手”的角度来编写它。最重要的是确保对新手来说确实有意义。您的老板显然不是审查此内容的合适人选，因为他不是目标受众。他是对的，只是要确保内容不会被他测试。另外，“新手”都只有“ 1周”才能成为新手……而且只有一种观点。因此，很可能（并建议）与每位新员工一起完善文档。实际上，将他们分配给他们的第一周是一项非常好的任务，即“更新新手手册”。

对于敏捷/ SCRUM：

做敏捷和SCRUM最困难的部分是“真正”地做。

为了阅读，我将从http://agilemanifesto.org/开始，然后从那里开始。

我还将阅读著名的http://www.halfarsedagilemanifesto.org/，它加重了您实际上必须包含所有方面才能使其工作的事实。如果您必须为组织大量修改敏捷，那么人们可能会想从中获得好处-而没有使用正确的流程。这个事实本身应该被提出来避免任何半定的态度。

听起来您将不得不在记录实践之前引入一些实践！

a）源代码控制-如何存储源代码和进行版本控制

b）版本管理和跟踪-您如何进行构建，为版本编号，将当前候选版本与先前版本进行比较

c）问题管理-您如何跟踪版本中的错误。

这些是非常基本的东西，但是它们可能要花很多时间（并且可能要花钱）来实现。

我将在开发人员手册中包括的主题：

• 部门内的角色/职位及其相应职责
• 开发人员机器软件要求（即所需的开发环境）
• 在何处以及如何访问源代码存储库
• 正在使用的开发工具（例如IDE）
• 编码风格/标准
• 文件标准
• 测试过程
• 建立过程
• 部署过程
• 支持和问题管理流程
• 在哪里可以获得本手册的最新版本

请记住，该手册仅应包含特定于开发的项目，而不应包含公司范围的信息（应在员工手册中）。

使用源代码控制

• 您正在使用哪个源代码控制工具。
• IDE中常用命令/工具的语法。
• 分支/合并策略。
• 提交的单位应该是什么？文件检出/未提交多长时间了？
• 提交/签入表示什么级别的“完成”？编译？单元测试通过了吗？已审查？
• 提交/签入的注释中应包含哪些内容。
• 回滚过程。