求教～各位大佬的公司的项目文档是怎么管理的

2020-04-20 18:55:23 +08:00
 szuwl

sql 和 api 文档之类的，能不能全用 md 文件记录，我觉得加入版本管理，能追溯到每一次改动挺好的，不知道有没有更好的方式

2251 次点击
所在节点    程序员
11 条回复
xuanbg
2020-04-20 19:15:08 +08:00
我们的文档就基本上是 MD，和代码在一个仓库，这样比较方便。不是 MD 的除了流程图外，都是不会更新的。流程图也是个 xml 文件，所以一点也不影响。
msaionyc
2020-04-20 19:25:28 +08:00
企业 Wiki 很好用
opengps
2020-04-20 19:34:26 +08:00
知识库啊
wangkun025
2020-04-20 19:36:55 +08:00
企业 wiki 是啥？
KentY
2020-04-20 20:03:05 +08:00
我们是 confluence 跟随项目代码一起的 md 并用
业务性, 知识性的在 confluence
代码 deployment, local test etc. 在代码的 repo 里
其实也有问题, 一旦有业务性改动, 总会忘记更新 confluence wiki, 甚至代码变话, 有时候也会忽视 md 文件的更新.
SpencerCJH
2020-04-20 20:45:09 +08:00
confluence
lc7029
2020-04-20 22:10:16 +08:00
SVN，定稿都是 PDF
beyondex
2020-04-21 09:06:28 +08:00
用归海数据，一个桌面文件全文搜索引擎，不过发现这个可以部署在服务器上，然后提供 Web 访问，这样的话大家都可以搜索
HENQIGUAI
2020-04-21 12:50:09 +08:00
没有文档
targz
2020-04-21 13:33:22 +08:00
语雀
gz911122
2020-04-21 14:49:51 +08:00
confluence 就完事了

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/664393

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX