出于安全及 offline 也可用的目的,最近实践中的一个做法是,用 Jekyll 来作为内部文档的工具,研发团队通过 git 协作,文档就是一个跑在自己机器上的网站。如果有必要,甚至可以把文档网站做成 launchd 任务开机自启动。
http://jekyllrb.com/
http://jekyllrb.com/
|
1
gitbook
|
|
dx3759Dec 9, 2014
2
开发团队文档应该加上全文索引。
另外一个更大的问题是项目更新了但是文档滞后,靠开发人员自觉是一件成本很高的事情。 |
|
harmyDec 9, 2014 via iPhone
3
提一下owncloud
|
|
xing393939Dec 9, 2014
4
dukuwiki不错,有php环境就行
|
|
zhouzmDec 9, 2014
5
自架 readthedoc
|
|
andyDec 9, 2014
7
文档、文件管理的话,推荐dukuwiki配合插件nspages、pagehere。
|
|
leptureDec 9, 2014
8
为什么不用 sphinx 呢? Markdown 写个博客是够用的,但是做文档还远远不行呢。
|
|
huigeerDec 9, 2014
9
JIRA
|
|
tolbkniDec 9, 2014
10
|
|
curiousjudeDec 9, 2014
11
我们是在内网搭了一个 daux.io 用于客户端的API文档,感觉勉强可用吧。没有搜索功能是个很大的问题,目录的组织也不尽如人意。
|
|
virusdefenderDec 9, 2014
14
|
|
zyAndroidDec 9, 2014
15
我们是用 Sphinx 做的
|
|
ryanking8215Dec 10, 2014
16
bitbucket repo的wiki,支持markdown,主要是api描述,markdown完全胜任
|
|
kimmykuangDec 10, 2014
17
我们是用redmine的,搭建在远程测试服务器上
|
|
TankyWooDec 10, 2014
18
我们现在就是这么做的.
jekyll的模板和Jinja2语法基本类似,修改非常方便。内部有需求可以自主修改. inotify 监控文档源文件目录,自动更新. 除非文档数量庞大、关联性较大,否则用这个还是很轻便的,顶多维护一个Index将文档串联起来。 |
|
xuhai951753Dec 10, 2014
19
|
|
20
@xuhai951753 cool
|