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

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 3015 天前的主题，其中的信息可能已经有所发展或是发生改变。

rt ，最近我们公司来了个在国企工作过的 tech leader ，带来了文档编写规范一系列改革.....，其中要求技术文档落地到 word ，放 svn 上去.....

mac 上编写 word 感觉好痛苦啊..... 而且对 word 也不熟....

word

文档

编写

svn

52 条回复 • 2019-10-30 18:44:16 +08:00

DT27

2016-08-03 15:26:16 +08:00

都要求 word 了。。。你就别想那么多了~~~

ixiaozhi

2016-08-03 15:37:19 +08:00

我用 rap

bibizhang

2016-08-03 15:39:43 +08:00

换我就辞职了

ahcat

2016-08-03 15:40:52 +08:00

用百度的 UEditor 写，然后按照公司的文档规范，通过脚本转换成指定样式的 Word 文档、 PDF 文档。

daya

2016-08-03 15:41:16 +08:00 via Android

用键盘(滑稽)

checgg

2016-08-03 16:07:20 +08:00

README.md 不是挺好的吗。

knktc

2016-08-03 16:09:08 +08:00

用 wiki 写……

tomczhen

2016-08-03 16:15:18 +08:00

之前用的 hexo 在内网搭了个，利用 git hook 做的自动部署更新。后面用了 gitlab 的 wiki ，然后创建了一个仓库放一些交流文档。

虽然目前只有我一个人写就是了。

ThomasChan

2016-08-03 17:55:25 +08:00

@bibizhang 😂 那还不至于

hpeng

2016-08-03 18:01:09 +08:00 via iPhone

领导说什么就什么啦， word 很聪明的，你用 md 写，生成 pdf ，转换成 word 。

neil90

2016-08-03 18:16:37 +08:00

我用 Pages

iyaozhen

2016-08-03 18:31:10 +08:00 via Android

用 word 。有统一模板
office for Mac 很好用呀， markdown 你都会 word 还有啥难的啊

scnace

2016-08-03 18:56:25 +08:00 via Android

md->pdf->word +1

cxbig

2016-08-03 19:01:20 +08:00

技术文档一律 Markdown 。可放项目 /docs/目录或独立 repo 。至于 SVN 还是 Git 无所谓。

21grams

2016-08-03 19:01:48 +08:00

我觉得用 word 挺好的，文档是给别人看的，你不能光自己一个人 high 。

zhouxuchen

2016-08-03 19:02:29 +08:00 via iPhone

文档放禅道，用的好像是 ueditor ，挺蛋疼的

nisekoi

2016-08-03 19:02:56 +08:00 via iPhone

apidocjs 自动生成

yjxjn

2016-08-03 19:03:32 +08:00 via iPhone

IBM notes

Tneciv

2016-08-03 19:15:52 +08:00 via Android

本来我一直用 gitbook 写然后生成 html 给出去然而换了新领导说这样的文档显得不专业要用 word 写完转成 pdf …
我真的是没话说再结合其他事情已经准备走了…

changqingshuya

2016-08-03 19:43:37 +08:00 via iPhone

为啥不用 wiki

ThomasChan

2016-08-03 20:43:06 +08:00

@changqingshuya 审计公司太 low ，人家觉得有 word 文档才是专业的， 233333

AsaMyth

2016-08-03 22:01:31 +08:00 via Android

之前在制造业，用开目系列。。

rashawn

2016-08-03 22:16:15 +08:00

写代码的时用标签夹在里面然后生成的时候单独调出来估计不难

BUPTGuo

2016-08-03 22:38:33 +08:00

既然版本控制，为什么不 wiki ，也导出 word

neosfung

2016-08-03 22:40:06 +08:00

latex

LINAICAI

2016-08-03 22:45:05 +08:00

应该用 Markdown 工，随便转 work 和 pdf

sheep3

2016-08-03 23:20:15 +08:00

有个 wiki 平台，忘记叫什么了

exoticknight

2016-08-03 23:23:59 +08:00

9hills

2016-08-04 00:21:26 +08:00 via iPad

word 加 svn 这个组合太奇葩了吧

wellsc

2016-08-04 00:28:43 +08:00 via Android

我司也是 svn+ word …

kneep

2016-08-04 08:29:00 +08:00 via iPhone

越大越土，肯定是 word 啦

CodingPuppy

2016-08-04 08:40:02 +08:00

你确定他是 tech leader ？

tinyproxy

2016-08-04 09:22:55 +08:00 via iPhone

confluence

ThomasChan

2016-08-04 09:55:42 +08:00

@tinyproxy 我们之前也用 confluence ，我昨天试用了下 pages 还挺好使的😂

uxstone

2016-08-04 10:25:17 +08:00

这个得看公司是做什么的吧,
有的项目不需要频繁的版本更新,接口什么的基本不变动,用 word 也无所谓了
但如果文档更新频繁,还用 word,那就是在作死....

不过讲真,用 word 文件保存的真的很 low,
pdf 格式的都比 word 好!

domty

2016-08-04 10:29:21 +08:00

用 word...
写麻烦，读起来更麻烦。

wiki 什么的不就挺好吗

pljhonglu

2016-08-04 10:40:14 +08:00

有道云协作~支持 markdown~

tinyproxy

2016-08-04 10:50:52 +08:00

@ThomasChan 复制粘贴图片实在不能太爽，之前拿 markdown 写过几年，每次需要插入图片都是先传图床粘贴外链，这一套操作下来我都快忘记我刚才要写啥了。

oska874

2016-08-04 11:07:11 +08:00

word,还必须用公司模板。

chilaoqi

2016-08-04 11:47:03 +08:00

Google 全家桶。当然用 Google docs 了啊。

Hant

2016-08-04 11:50:13 +08:00

Pages 不能用吗

zhaojames077

2016-08-04 11:53:14 +08:00 via iPhone

文档用 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