Pet*_*erK 6 language-agnostic documentation project-management
通常情况下,项目会传递给其他人.通常这个过程对双方来说都是不愉快的 - 新主人抱怨可怕的文档,错误和糟糕的设计.然后,原来的所有者因为有关项目的问题,修复旧错误等的请求而困扰了几个月.
我可能很快就会将我的一个项目提供给其他人,这样我就可以专注于我的其他项目.我想知道我该怎么做才能使这种转移尽可能顺利.我已经拥有的是一个体面的文档,代码是相当好的评论,我仍然在改进它.它是一个中等规模的项目,不是很大但仍然不是你可以在一周内编码的东西.
我正在寻找一系列应该做的事情,以帮助未来的所有者接管项目,同时将为我提供所有那些烦人的问题,例如"这个功能做了什么,这个课程的目的是什么有...".我知道文档是必须的 - 还有什么？
注意:虽然我的项目是用C++编写的,但我相信这是一个与语言无关的问题.如果您认为某些语言特定的内容,请同时提及.
文档，但在所有级别：
并且，首先，亲自向该人介绍上述所有内容，希望以结对编程的方式进行一些必要的更改