这是一个创建于 3604 天前的主题，其中的信息可能已经有所发展或是发生改变。
用word的话,如果哪个地方有更新,还得用红色标注,用git提交的log看还不知道改了哪些. 大家是用哪种方式写开发文档的?word,google doc, mkdown还是html?
 |
1
acgeo 2015-01-20 14:09:04 +08:00
markdown
|
 |
2
hyzjshwo 2015-01-20 15:10:26 +08:00
我们搭了个dokuwiki 文档扔上面
|
 |
3
zhkzyth 2015-01-20 15:15:47 +08:00
产品的需求是word。
开发这边，后台我们用markdown把一些开发规范、设计方案之类的都用markdown。 |
 |
4
ggarlic 2015-01-20 15:15:57 +08:00
楼主无非就是想需要个带版本管理的东东
无非就是 wiki、confluence、git+各种纯文本格式 我们用的confluence |
 |
5
lujiajing1126 2015-01-20 15:32:32 +08:00
api文档用swagger
或者wiki |
 |
6
ryzn 2015-01-20 15:56:25 +08:00
用html写文档。。。这么牛逼。
|
 |
7
gancl OP @acgeo @zhkzyth Markdown 表格支持不好,还要有学习成本,团队成员不一定会用
@ggarlic confluence还是收费的,我想找免费的或开源的 @lujiajing1126 感觉swagger不通用,想统一管理文档,而不只做api文档 |
 |
9
ivenvd 2015-01-20 16:30:54 +08:00
还得用红色标注？Σ(っ °Д °;)っ
你们公司的 Word 不带审阅工具么？ |
|
10
lujiajing1126 2015-01-20 16:32:39 +08:00
@gancl 我们用dokuwiki。。比较轻量级
|
1 |
12
mcfog 2015-01-20 16:48:17 +08:00
我觉得先要想明白 — 你们写的文档的目标用户是谁？
如果是对外的，给其他合作公司看的，那么pdf输出，changelog，乃至可调试的环境比较重要 如果是对内的，自己备查或者指导新人的，那么日常维护方便，和代码结合紧密比较重要 没有工具能够兼顾所有需求，所以分不同场景选用合适的工具才最好 |
 |
13
jianghu52 2015-01-20 16:56:52 +08:00
如果是给客户看的，那么我还能忍受，如果是给对内人看的，我觉得贴代码，结对编程都比维护文档要有意义多。
领导总是觉得，留下了文档，这个项目没了谁都能转。其实大家都知道，上年头的代码，哪个没几个地下室，真要是离开了某个熟悉的人，项目还就有可能停摆。 |
 |
14
cloudzhy 2015-01-20 17:06:46 +08:00
wiki比较好，想写就写，不写就没有。
|
 |
16
f3ngx 2015-01-20 19:39:23 +08:00
texmacs这个软件很赞，wysiwyg（所见即所的），格式是文本（易于版本管理），快捷键还算方便、一些插入图表的特性不错、容易输出各种格式（pdf、ps、html...)，体积还算小巧（几十兆）
|
 |
17
loveuqian 2015-01-20 20:01:21 +08:00
我们项目组用excel。。。。。。。。。。
|
 |
18
m1a0 2015-01-21 11:28:30 +08:00
@ivenvd 正解
我们目前强制要求使用word的审阅功能， 有什么变更一目了然， 再配合版本控制工具， 查看两个版本之间的差别很轻松。 markdown什么的虽然可以通过版本控制来查看变更， 但是感觉是给开发人员用的， 对于非开发人员不友好。 |
 |
19
zerh925 2015-01-21 11:57:08 +08:00
sphnix
|
 |
21
guguai 2015-01-21 17:08:10 +08:00
在看到这个题的时候，想一会就想到，一般在文档中需要图要进行形象的描述，虽然markdown可以加上图片链接，但是在你去看的时候，那时根本就看不到图片咧~
|
 |
22
jimrok 2015-01-21 18:04:24 +08:00
gitbook
|
 |
24
kshift 2015-02-08 16:00:58 +08:00
Tower 的文档有版本功能，可以 diff 高亮显示区别。
另外，Tower 的编辑器 Simditor 之后会增加文本高亮功能，也许可以满足你的需求。 Tower -> https://tower.im |
 |
25
balabalaguguji 2019-10-30 18:51:17 +08:00
易文档很好用，应该是市面现在做的最好的，https://easydoc.top
|
Select Language