• 请不要在回答技术问题时复制粘贴 AI 生成的内容
szuwl
V2EX  ›  程序员

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

  •  
  •   szuwl · Apr 20, 2020 · 3316 views
    This topic created in 2391 days ago, the information mentioned may be changed or developed.

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

    11 replies  •  2020-04-21 14:49:51 +08:00
    xuanbg
    xuanbg
    Apr 20, 2020
    1
    我们的文档就基本上是 MD,和代码在一个仓库,这样比较方便。不是 MD 的除了流程图外,都是不会更新的。流程图也是个 xml 文件,所以一点也不影响。
    msaionyc
    msaionyc
    Apr 20, 2020 via Android❤️2
    2
    企业 Wiki 很好用
    opengps
    opengps
    Apr 20, 2020 via Android
    3
    知识库啊
    wangkun025
    wangkun025
    Apr 20, 2020
    4
    企业 wiki 是啥?
    KentY
    KentY
    Apr 20, 2020
    5
    我们是 confluence 跟随项目代码一起的 md 并用
    业务性, 知识性的在 confluence
    代码 deployment, local test etc. 在代码的 repo 里
    其实也有问题, 一旦有业务性改动, 总会忘记更新 confluence wiki, 甚至代码变话, 有时候也会忽视 md 文件的更新.
    0dJ6Tu8Za734L89T
    0dJ6Tu8Za734L89T
    Apr 20, 2020
    6
    confluence
    lc7029
    lc7029
    Apr 20, 2020
    7
    SVN,定稿都是 PDF
    beyondex
    beyondex
    Apr 21, 2020 via Android
    8
    用归海数据,一个桌面文件全文搜索引擎,不过发现这个可以部署在服务器上,然后提供 Web 访问,这样的话大家都可以搜索
    HENQIGUAI
    HENQIGUAI
    Apr 21, 2020
    9
    没有文档
    targz
    targz
    Apr 21, 2020
    10
    语雀
    gz911122
    gz911122
    Apr 21, 2020
    11
    confluence 就完事了
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1729 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 45ms · UTC 15:56 · PVG 23:56 · LAX 07:56 · JFK 10:56
    ♥ Do have faith in what you're doing.