话说你司的 API 文档是如何进行管理的？

[ansheng]

遇到一个尴尬的问题，我司 API 文档都是使用 markdown 来写的，然而是放在项目目录下面的 README.md 中，但是多人人多的时候修改起来就比较麻烦，就想用有没有一种在线的 API 文档管理程序撒的，石墨固然好，好像不支持 Markdown 所以没打算用。

哎。 Fuck

[nameldk]

文档是写在代码里，然后有专门处理程序会把代码的文档提取出来，生成 api 文档，同时生成测试工具:)

[a412739861]

@kooze #22 还不错了，我们是代码讲那过去的故事……

[zhleonix]

用 Swagger 或者 RAML 写 YAML 规范，自动产生文档和代码。

[xieweizhi007]

apiary

[xieweizhi007]

更正： apiary

[G900]

GitLab ，和代码分开，做一个单独的 doc 库，用 markdown 写，管理方便

[V2exUser]

@subdued 听过口耳相传，实在想不出贵司的口口相传是怎样的风景。

[orvice]

swagger :)

[xu1ming]

我司 google doc

[mingyun]

dokuwiki

[loveuqian]

就一条 curl 命令

[Jakesoft]

竟然没有 sphinx ，专业文档编写 100 年

[zzyzxd]

前公司是把 git 目录 mount 到一个 MkDocs 的 container 里……

[jwangkun]

没人推荐小幺鸡么？

[yalanaika]

html - chm

[libook]

个人觉得 API 文档维护的最大问题是忘记维护，或者有时候赶时间就懒得维护，所以个人倾向于将 API 文档与代码放在一起。
我们是 JS 全栈， JS 有一套 JSDoc 标准，适用于非 API 场景的文档编写，依照这个标准，有一个 APIDoc 工具，可以用类似 JSDoc 的方式在代码中用注释编写 API 文档，但是在实际应用过程中感觉不适合我们的应用场景，所以自己写了一个 URIDoc https://www.npmjs.com/package/uridoc
目前还是 v1 的初级阶段，欢迎 Fork 和 PullRequest

[eurry]

https://www.showdoc.cc/
showDoc

[hareandlion]

口口相传 +1

[tangbl93]

word + 1

[billion]

@WhoMercy 我前公司就是这样的。