冻结的项目-我应该留给我后面的人什么?


14

因此,我一直在从事的项目将无限期冻结。如果再次冻结项目时,可能不会将其分配给我或当前团队中的任何人。实际上,我们是在项目冻结之前继承了该项目,但是先前的团队没有任何东西可以帮助我们甚至了解项目的基本需求,因此我们浪费了很多时间来很好地了解项目。我的问题是,您认为我们应该怎么做才能帮助后世的人们最好地了解项目的需求,我们做了什么,为什么要这样做等?我对​​我们为什么应该离开的其他想法持开放态度。一些对其他人也可以在该项目上工作的曲目。

我们已经采取的一些步骤:

  • 技术文档(不完整,但至少有一些);
  • 源控制系统的历史;
  • 估算项目的哪些部分需要改进以及我们为什么要这样做;
  • 一堆单元测试。
  • 我们已完成的所有票证的问题跟踪器(编辑

您如何看待我们已经准备好的东西,我们还能做什么?


2
考虑与该项目相关的问题跟踪器中易于获取的票证列表
gnat

1
README.TXT 中尽可能多地使用项目源回答了“为什么?” 。

@gnat感谢您的想法。它使我想起我忘了提它了。我们将问题跟踪器与所有票证一起使用。我将其添加到列表中。
nyxz 2012年

1
对于您废弃的代码库,我要表示声援。 zdnet.com/blog/projectfailures/...
本·德莫特

Answers:


9

还有更多需要考虑的事情

  • 项目目录结构健全吗?您是否修改了代码注释?提交日志是否可以显示?
  • 总体目的概述(相对于您刚开始的技术而言),关于项目的建议阅读,项目历史(其开发周期,以前的项目经理,人员列表,需求/功能规格)
  • UML图,类图,工作流程图!
  • 项目被冻结的原因总是很好。
  • 开发环境,已经使用过的IDE,构建工具,这些都涵盖在技术文档中了吗?

我只是想到了一些我想在最近继承的项目中看到的东西。您已经提供的东西比我得到的更多。您将获得主要的业力积分,可以帮助下一支团队:)


8

我在接别人的项目时想要拥有的东西是:

生成说明,包括工具链中所有工具的最新已知工作版本。编译器,IDE等会随着时间的推移而变化,如果以前的开发人员向我提供了有关如何启动和运行的说明,则操作起来会容易得多。

运行环境说明-运行该程序需要具备哪些条件?再次提及什么版本会有所帮助。我最近捡起了一些文件,这些文件需要将一组特定的文件保存在某个位置,并且我不得不去问问其他开发人员以弄清楚该文件。自从另一个开发人员可用以来,这没什么大不了的,但是如果他没有,那将是个问题。

可以肯定的是,提交给存储库的代码实际上可以签出和构建。我曾经选择一个项目,以前的开发人员(幸运的是还在)对Makefiles做过一些真正奇怪的事情,以致您无法从干净的签出中构建项目。不用说,我首先必须纠正这一点,然后才能实际进行任何工作。如果以前的开发人员不可用,那么可能要花更长的时间才能克服这一障碍。

对项目意图的一般说明。这个软件是做什么用的?尽可能简短,但有些概述确实会有所帮助。


+1为完整的工具链。如果您无法构建和测试软件,那么世界上所有的文档都将无济于事。在可能的情况下,我希望包含所有工具的安装映像(尽管如今,我可能会选择某种VM映像)。没有什么比找出构建过程更糟糕的了,它依赖于一个不再存在的公司的第三方插件!
TMN 2012年

@TMN-这就是为什么我倾向于回避诸如商业IDE插件之类的事情。我不相信以后可以重现环境。在使用了20多年的软件之后,我从不认为一切都会消失。
迈克尔·科恩

4

ScreenCast

当我离开上一份工作时,实际上我进行了未经编辑的截屏视频,从我所听到的信息来看,这对入职新人非常有帮助。我带我的团队在一个房间里,安装了电容麦克风,并在录制音频和屏幕时向他们解释了我对项目的了解。然后,我让他们问我有关此问题。与我坐下来并试图一整天都尽可能快地打字相比,我们能够获得更多的记录信息。


+1这很简单,但是非常有意义。
lwm 2012年

2

如果您不了解此信息,请添加业务需求。

  1. 客户想要什么?
  2. 这些变化如何促进了这一点?
  3. 满足客户需求有哪些挑战?
  4. 没有满足什么需求,为什么?

1

运行独立的开发系统的虚拟机映像(即vm-ware)可能非常有价值。

去年,我被要求修复一些vb3代码。用vb3,windows95和许多已安装的ole-controls重新创建一个正在运行的系统非常困难。一个星期后,我放弃了:-(

[更新] 有没有人经历过转换旧的虚拟机映像以便可以在更新的虚拟机播放器中播放的经验?

您还必须考虑到,在现代硬件/来宾操作系统上可能无法再运行非常老的映像。


考虑提出一个有关升级虚拟机的新问题。

@ThorbjørnRavn安徒生。你说的没错。我重新制定了答案的最后一部分。
2012年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.