大家公司技术文档都是拿什么写啊

2016-08-03 15:22:49 +08:00
 ThomasChan
rt ,最近我们公司来了个在国企工作过的 tech leader ,带来了文档编写规范一系列改革.....,其中要求技术文档落地到 word ,放 svn 上去.....

mac 上编写 word 感觉好痛苦啊..... 而且对 word 也不熟....
8854 次点击
所在节点    问与答
52 条回复
Hant
2016-08-04 11:50:13 +08:00
Pages 不能用吗
zhaojames077
2016-08-04 11:53:14 +08:00
文档用 markdown 写,用 mkdocs 做展示;文档传到 GitLab ,通过 git hook 自动更新 mkdocs 文档目录。
kxxoling
2016-08-04 12:10:10 +08:00
Sphinx + ReadTheDocs
konakona
2016-08-04 12:12:47 +08:00
markdown (对技术)+wiki(对普通)
exch4nge
2016-08-04 12:32:05 +08:00
正式点的技术文档,如什么需求分析、概设、详设之类的,用 word ;其余用啥都行,喜欢 reStructuredText 。

话说楼里好多用 word 就要跳槽的, word 怎么就遭嫌弃了,用好 word 的样式表,还是能够写出漂亮的文档的, word 也有修订之类的功能,协作起来也不错。
xiaonengshou
2016-08-04 12:52:09 +08:00
用 word 没毛病啊。
ikaros
2016-08-04 13:05:28 +08:00
word 好像不是纯文本吧? SVN 能追踪改动?
ThomasChan
2016-08-04 14:08:00 +08:00
@ikaros 二进制,并不能追踪,目的可能是为了公司审计用...
A07de21s
2016-08-04 14:19:03 +08:00
用 MarkDown
BlueMeow
2016-08-04 14:25:39 +08:00
@ikaros 可以用外置工具提取字符串的,这样就可以做 diff 了
mengzc
2018-08-09 15:01:44 +08:00
公司如果有内部在线的技术文档平台那用 MD 写是不错的,不然技术文档 word 或者 pdf 格式还是最佳的,便于发送和阅读,尤其是对图片的支持,产品的技术手册图文并茂是必须的。
balabalaguguji
2019-10-30 18:44:16 +08:00
推荐你试下易文档,我用过最好的一个: https://easydoc.top

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

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

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

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

© 2021 V2EX