Documentation 关闭一个项目-要做的关键事情是什么?

Documentation 关闭一个项目-要做的关键事情是什么?,documentation,history,projects,maintenance,Documentation,History,Projects,Maintenance,看来我们的客户很可能会取消我们已经做了15个月的项目 它有可能(尽管不太可能)在某个时候重新启动 同时,我们还将公司的产品扩展到多个领域。其他项目团队可能需要进行类似的扩展,我们希望他们能够利用我们所做的 那么,为后代记录哪些关键的事情,以便未来的团队(可能包括不同的人员)能够从我们所做的事情中学习 这与为未来的维护人员记录的内容稍有不同,因为人们到达时可能对我们的项目不太熟悉/不熟悉,并且可能不会有任何扩展的参与 到目前为止,我们一直在收集关于每个主要特性/扩展的信息-因此有一个地方可以查找需

看来我们的客户很可能会取消我们已经做了15个月的项目

它有可能(尽管不太可能)在某个时候重新启动

同时,我们还将公司的产品扩展到多个领域。其他项目团队可能需要进行类似的扩展,我们希望他们能够利用我们所做的

那么,为后代记录哪些关键的事情,以便未来的团队(可能包括不同的人员)能够从我们所做的事情中学习

这与为未来的维护人员记录的内容稍有不同,因为人们到达时可能对我们的项目不太熟悉/不熟悉,并且可能不会有任何扩展的参与

到目前为止,我们一直在收集关于每个主要特性/扩展的信息-因此有一个地方可以查找需求、指向源代码的指针、测试用例等,并且正在添加一些关于关键设计点/决策等的叙述


当项目团队还在一起的时候,我们还应该做什么和捕捉什么呢?

我知道这不是很具体。但对于你做出的每一个关于设计或技术选择的重大决定,一定要记录下“为什么”


这有助于进一步发展,特别是如果将来从事该项目的人员与最初的团队不同。

我知道这不是很具体。但对于你做出的每一个关于设计或技术选择的重大决定,一定要记录下“为什么”


这有助于更进一步,特别是如果将来从事项目的人员与原始团队不同。

请确保保存存储库或每个文件历史的某些表示形式。了解它是如何演变的,以及某些功能(或bug)是何时引入的,这对于在不知情的情况下进入某个领域非常有用。

确保保存存储库或每个文件历史的某些表示。在不知情的情况下,了解它是如何发展的,以及某些功能(或bug)是何时引入的,这真的很有用。

这不仅应该在项目关闭时完成,而且应该作为一个干净的项目完成。正如您在项目管理文献中所读到的,有一个项目结束文档,这将给一个局外人进入项目的可能性。所以你的任务并不罕见


首先,为项目源代码创建一个专用的位置,可能可以使用浏览器浏览,因此查看团队所做工作的障碍非常小。还要确保您的文档(架构等)可用。在此之后,您可以开始编写一个项目体验wiki,在这里您可以以一种干净且可追踪的方式链接某些人工制品。也许有一个维基页面可以帮助你解决你遇到的难题。如果你已经做到了这一点,其他人应该可以很容易地利用你对项目的了解。

这不仅应该在项目关闭时完成,而且应该作为一个干净的项目完成。正如您在项目管理文献中所读到的,有一个项目结束文档,这将给一个局外人进入项目的可能性。所以你的任务并不罕见


首先,为项目源代码创建一个专用的位置,可能可以使用浏览器浏览,因此查看团队所做工作的障碍非常小。还要确保您的文档(架构等)可用。在此之后,您可以开始编写一个项目体验wiki,在这里您可以以一种干净且可追踪的方式链接某些人工制品。也许有一个维基页面可以帮助你解决你遇到的难题。如果你已经掌握了这一点,其他人应该很容易利用你对项目的了解。

你可能想看看下面的帖子:


虽然它没有涵盖你想要的一切,但它可能是一个很好的起点。

你可能想看看下面的帖子:


虽然它没有涵盖你想要的一切,但它可能是一个很好的起点。

同意-这就是我所说的“关于关键设计点/决策的叙述”。如果没有这些信息,很难重新解释为什么事情没有以特定的方式进行。同意-这就是我所说的“关于关键设计点/决策的叙述”。如果没有这些信息,很难重新解释为什么事情没有以特定的方式进行。是的。源代码在可预见的将来不会被删除。是的。源代码在可预见的将来不会被删除。好东西,应该做,但不是我的意思。这更多的是吸取“经验教训”——我们肯定应该这样做——而不是研究如何保存我们所拥有和知道的东西。好东西,应该做,但不是我的意思。这更多的是吸取“经验教训”——我们肯定应该这样做——而不是研究如何保存我们所拥有和知道的东西。