It seems probable our client will cancel the project we've been working on for 15 months.
我们的客户似乎很可能取消我们已经工作了15个月的项目。
It's possible (although not very likely) that it will get restarted at some point.
有可能(尽管不太可能)它会在某个时刻重新启动。
We've also extended our company's product in several areas while doing this. Other project teams may need to make similar extensions, and we'd like them to be able to make use of what we did.
在这样做的同时,我们还在多个领域扩展了公司的产品。其他项目团队可能需要进行类似的扩展,我们希望他们能够利用我们所做的工作。
So, what are the key things to record for posterity, so that a future team (which may include different personnel) can learn from what we've done?
那么,为后代记录的关键事项是什么,以便未来的团队(可能包括不同的人员)可以从我们所做的事情中学到什么?
This is slightly different from what to record for future maintainers, since people will probably arrive with little/no familiarity with our project, and will probably not have any extended involvement with it.
这与未来维护者的记录略有不同,因为人们可能很少/不熟悉我们的项目,并且可能没有任何扩展的参与。
So far, we've worked on collecting information about each major feature/extension - so there's one place to look for requirements, pointer to the source code, test cases, etc, and are adding some narrative on key design points/decisions etc.
到目前为止,我们一直致力于收集有关每个主要功能/扩展的信息 - 因此,有一个地方可以查找需求,指向源代码的指针,测试用例等,并在关键设计点/决策等方面添加一些叙述。
What else should we be doing and capturing, while the project team is still together?
当项目团队还在一起时,我们还应该做些什么以及捕获什么呢?
4 个解决方案
#1
I know this isn't very specific. But for every major decision you made about design or choice of technology, be sure to record "why".
我知道这不是很具体。但是,对于您在设计或选择技术方面做出的每一项重大决定,请务必记录“为什么”。
This helps a lot further down the track especially if the people working on the project in future are not the same as the original team.
这有助于在轨道上更进一步,特别是如果将来从事该项目的人员与原始团队不同。
#2
Make sure you save your repository, or some representation of each file's history. It's really useful, coming into something with no knowledge, to see how it evolved, and when certain features (or bugs) were introduced.
确保保存存储库或每个文件历史记录的某些表示。它非常有用,可以进入没有知识的东西,看看它是如何演变的,以及何时引入某些特征(或错误)。
#3
You might want to look at the following post: What's your Post-Mortem meeting format?
您可能希望查看以下帖子:您的Post-Mortem会议格式是什么?
Whilst it doesn't cover everything you want, it's probably a good starting point.
虽然它没有涵盖你想要的一切,但它可能是一个很好的起点。
#4
This should be done not onyl if the project will be closed down but also as a clean project finish. As you can read in project management literature there's a project closing documentation, which would give a an outsider the possibility to dife into the project. So your task is not very uncommon.
如果项目将被关闭,这应该不是onyl,而是作为一个干净的项目完成。正如您可以在项目管理文献中看到的那样,有一个项目结束文档,这将使局外人有可能进入项目。所以你的任务并不罕见。
First of all create a dedicated place for the projects sourcecode, maybe browsable with a browser, so the barrier to look into what your team has done is very small. Also make sure that your documents (architecture etc) are available. After this you can start to write a project experience wiki, where you link certain artefacts in a clean and traceable manner. Perhaps with a wikipage for very hard problems you encountered and the solution. If you've got this, it should be very easy for others to take advantage in your knowledge about the project.
首先为项目源代码创建一个专门的位置,可以浏览浏览器,因此查看团队所做的事情的障碍非常小。还要确保您的文档(架构等)可用。在此之后,您可以开始编写项目体验维基,在那里您可以以干净和可追踪的方式链接某些文物。也许是因为你遇到的非常困难的问题和解决方案的wikipage。如果你有这个,那么其他人应该很容易利用你对项目的了解。
#1
I know this isn't very specific. But for every major decision you made about design or choice of technology, be sure to record "why".
我知道这不是很具体。但是,对于您在设计或选择技术方面做出的每一项重大决定,请务必记录“为什么”。
This helps a lot further down the track especially if the people working on the project in future are not the same as the original team.
这有助于在轨道上更进一步,特别是如果将来从事该项目的人员与原始团队不同。
#2
Make sure you save your repository, or some representation of each file's history. It's really useful, coming into something with no knowledge, to see how it evolved, and when certain features (or bugs) were introduced.
确保保存存储库或每个文件历史记录的某些表示。它非常有用,可以进入没有知识的东西,看看它是如何演变的,以及何时引入某些特征(或错误)。
#3
You might want to look at the following post: What's your Post-Mortem meeting format?
您可能希望查看以下帖子:您的Post-Mortem会议格式是什么?
Whilst it doesn't cover everything you want, it's probably a good starting point.
虽然它没有涵盖你想要的一切,但它可能是一个很好的起点。
#4
This should be done not onyl if the project will be closed down but also as a clean project finish. As you can read in project management literature there's a project closing documentation, which would give a an outsider the possibility to dife into the project. So your task is not very uncommon.
如果项目将被关闭,这应该不是onyl,而是作为一个干净的项目完成。正如您可以在项目管理文献中看到的那样,有一个项目结束文档,这将使局外人有可能进入项目。所以你的任务并不罕见。
First of all create a dedicated place for the projects sourcecode, maybe browsable with a browser, so the barrier to look into what your team has done is very small. Also make sure that your documents (architecture etc) are available. After this you can start to write a project experience wiki, where you link certain artefacts in a clean and traceable manner. Perhaps with a wikipage for very hard problems you encountered and the solution. If you've got this, it should be very easy for others to take advantage in your knowledge about the project.
首先为项目源代码创建一个专门的位置,可以浏览浏览器,因此查看团队所做的事情的障碍非常小。还要确保您的文档(架构等)可用。在此之后,您可以开始编写项目体验维基,在那里您可以以干净和可追踪的方式链接某些文物。也许是因为你遇到的非常困难的问题和解决方案的wikipage。如果你有这个,那么其他人应该很容易利用你对项目的了解。