我将项目文档理解为软件项目演变的一部分,有时与代码联系在一起(尤其是在精益方法中)。这就是为什么我认为将它与修订控制系统中的代码(例如 git,在我的例子中)保持在一起可能是一个好主意。
Markdown 似乎是一种广泛采用且有效的协作编辑文本文档的解决方案。但是,当涉及到实体关系或序列图时,我不知道要使用哪种格式/软件,因此仍然可以进行差异和合并。
所以我的问题是:
- 将代码和文档保存在同一个存储库中实际上是个好主意吗?
- 如果是,您会使用哪种格式的图表?
我目前正在考虑一些文本 UML 图表工具,但我想知道您的意见。提前致谢!