- 前端架构:从入门到微前端
- 黄峰达
- 376字
- 2020-08-27 20:42:11
3.9 可编辑文档库:提升协作性
绘制完项目架构图后,我们就需要找到一个可编辑的文档中心。同样的,我们优先关注于其是否可以版本化、图形可视化,以及追踪历史修改。它可以是:
◎ 可以记录版本历史的维基(Wiki)软件。
◎ 专业的协作工具,比如Atlassian的Confluence。
◎ 基于Git+Markdown的代码管理工具。
它应该还能支持以下功能:实时多人编辑、内容索引、图形可视化、实时搜索、打标签、检查清单、导入导出等。
我们之所以对于编辑的文档中心有这样的要求,原因在于遇到过太多的“坑”。过去接收的二进制文档,诸如word等,太容易过期了,它们不能进行版本管理,讨论问题的时候,需要进一步确认。如果中间文档有更新,我们需要重新获取一份文档。在反复沟通之后,我们会产生对文档价值的怀疑。
一个好的文档中心能够从某种程度上解决这个问题。但是,它并不能解决所有的问题。对于一个长期的项目而言,笔者更希望这个文档是放置在代码仓库中的。