编写公司范围内的开发人员手册

Question

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

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

我的老板想让我写一本软件开发人员手册，它定义了我们用来完成任务的一般过程、协议、工具和指南。换句话说，他想要一本“这就是我们在这里做的事情”的书，以便让一位熟悉我们做事方式的新员工变得更容易，同时也能帮助我的老板了解他的手下在做什么，以及他们是如何做的。

在我看来，我正在奠定一个基础，它需要正确的做法。你将如何选择这样一本手册的主题？你能提供一些例子主题吗？

附带注意:如果这很重要，我们主要是微软的.NET商店。我们正在研究敏捷实践，比如XP和Scrum，但是我们可能需要对它们进行大量的修改，以使它们在我们的公司工作。

Answer 1

我会把它分成几个部分

• 现任工作人员姓名和职称(最好附有照片)
• 应用程序、登录到它们、需要知道的数据和提交的许可请求
• 公司网站和与业务相关的关键外部站点的书签
• 公司用于通讯、电子邮件、会议室预订、共享屏幕的应用程序。
• 与公司有关的活动的程序，例如费用收据，预订旅行
• 开发机器设置。详细描述设置新开发人员机器的过程。这通常是“预期”只需要一天，但通常需要3-5天的现实。
• 开发过程，如何跟踪、分配和更新工作，以及使用什么工具。
• 如何测试，测试什么，什么时候测试，在哪里测试。
• 编码标准包括文件命名约定和语言特定标准。
• 如何处理bug，在哪里记录它们，如何修复它们。
• 在部署过程中，需要知道的关键是什么来推动生产。
• 如何文档化，文档化，何时文档化。
• “is”，例如代码、数据、标准、文档、链接和其他资产的位置(S)。

将其模块化也会让您或其他人单独更新部分，例如，员工姓名和职位会随着人员的来来去去而频繁变化。

对于每一节，我都会努力从“新手”的角度来写。最重要的是要确保这对新手来说是有意义的。你的老板显然不是审查这个问题的合适人选，因为他不是预期的听众。他想要它是对的，只是要确保内容不会被他测试。另外，“新手”和“新人”都只有“一周”作为新手.而且只有一个观点。因此，很有可能(并建议)每个新员工对文档进行改进。事实上，给他们分配第一周的时间也是一项很好的任务。“更新新手手册”。

对于敏捷/SCRUM：

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

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

我还会读到著名的http://www.halfarsedagilemanifesto.org/，它增加了一个事实，那就是你真的必须接受所有的方面才能让它发挥作用。如果您必须为您的组织大量修改敏捷，那么人们很可能想要这些好处--而不使用正确的过程。这一事实本身应用来防止任何半无状态的情况。

Answer 2

听起来，你必须先介绍一些实践，然后才能把它们记录下来！

( a)源代码控制--如何存储源代码并进行修订控制

( b)发布管理和跟踪--如何进行构建、发布编号、将当前版本候选版本与先前版本进行比较？

( c)问题管理--如何跟踪版本中的bug。

这些都是非常基本的东西，但它们可能需要很长时间(可能还需要花费金钱)才能实现。

Answer 3

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

• 部门内的角色/职位及其相应的责任
• 开发人员机器软件需求(即所需的开发环境)
• 访问源代码存储库的位置和方法
• 正在使用的开发工具(例如IDE)
• 编码风格/标准
• 文件标准
• 测试过程
• 构建过程
• 部署过程
• 支助和问题管理进程
• 在哪里可以得到这本手册的最新版本？

请记住，本手册只应包含特定于开发的项目，而不应包含公司范围内的信息(员工手册中应该包含这些信息)。