关于开发团队的文档

2014-12-09 13:09:17 +08:00
 Livid
出于安全及 offline 也可用的目的,最近实践中的一个做法是,用 Jekyll 来作为内部文档的工具,研发团队通过 git 协作,文档就是一个跑在自己机器上的网站。如果有必要,甚至可以把文档网站做成 launchd 任务开机自启动。

http://jekyllrb.com/
6793 次点击
所在节点    程序员
20 条回复
tinyhill
2014-12-09 13:14:14 +08:00
gitbook
dx3759
2014-12-09 13:15:31 +08:00
开发团队文档应该加上全文索引。
另外一个更大的问题是项目更新了但是文档滞后,靠开发人员自觉是一件成本很高的事情。
harmy
2014-12-09 13:22:42 +08:00
提一下owncloud
xing393939
2014-12-09 13:27:01 +08:00
dukuwiki不错,有php环境就行
zhouzm
2014-12-09 13:42:19 +08:00
自架 readthedoc
Livid
2014-12-09 13:42:30 +08:00
@tinyhill 试了一下 Gitbook Editor,感觉不错。就是中文的字间距比较奇怪。
andy
2014-12-09 14:05:02 +08:00
文档、文件管理的话,推荐dukuwiki配合插件nspages、pagehere。
lepture
2014-12-09 15:04:04 +08:00
为什么不用 sphinx 呢? Markdown 写个博客是够用的,但是做文档还远远不行呢。
huigeer
2014-12-09 15:19:28 +08:00
JIRA
tolbkni
2014-12-09 15:27:38 +08:00
curiousjude
2014-12-09 16:02:34 +08:00
我们是在内网搭了一个 daux.io 用于客户端的API文档,感觉勉强可用吧。没有搜索功能是个很大的问题,目录的组织也不尽如人意。
flyaway
2014-12-09 16:51:03 +08:00
ivenvd
2014-12-09 18:44:32 +08:00
@lepture Sphinx 用于对外文档比较好吧……对内的话,往往不需要那么好的排版,而且团队学习成本太大了……
virusdefender
2014-12-09 19:19:27 +08:00
@curiousjude
@ivenvd

我们写api文档的东西是我用了两天自己写的。。都没这个高级~
zyAndroid
2014-12-09 23:14:03 +08:00
我们是用 Sphinx 做的
ryanking8215
2014-12-10 10:04:48 +08:00
bitbucket repo的wiki,支持markdown,主要是api描述,markdown完全胜任
kimmykuang
2014-12-10 11:45:46 +08:00
我们是用redmine的,搭建在远程测试服务器上
TankyWoo
2014-12-10 11:47:38 +08:00
我们现在就是这么做的.

jekyll的模板和Jinja2语法基本类似,修改非常方便。内部有需求可以自主修改.

inotify 监控文档源文件目录,自动更新.

除非文档数量庞大、关联性较大,否则用这个还是很轻便的,顶多维护一个Index将文档串联起来。
xuhai951753
2014-12-10 16:21:15 +08:00
yafeilee
2014-12-10 22:50:50 +08:00

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

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

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

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

© 2021 V2EX