ThomasChan
V2EX  ›  问与答

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

  •  
  •   ThomasChan · Aug 3, 2016 · 10668 views
    This topic created in 3747 days ago, the information mentioned may be changed or developed.
    rt ,最近我们公司来了个在国企工作过的 tech leader ,带来了文档编写规范一系列改革.....,其中要求技术文档落地到 word ,放 svn 上去.....

    mac 上编写 word 感觉好痛苦啊..... 而且对 word 也不熟....
    52 replies  •  2019-10-30 18:44:16 +08:00
    naver1
    naver1
    Aug 3, 2016
    1
    都要求 word 了。。。你就别想那么多了~~~
    ixiaozhi
    ixiaozhi
    Aug 3, 2016
    2
    我用 rap
    bibizhang
    bibizhang
    Aug 3, 2016
    3
    换我就辞职了
    ahcat
    ahcat
    Aug 3, 2016
    4
    用百度的 UEditor 写,然后按照公司的文档规范,通过脚本转换成指定样式的 Word 文档、 PDF 文档。
    daya
    daya
    Aug 3, 2016 via Android
    5
    用键盘(滑稽)
    checgg
    checgg
    Aug 3, 2016
    6
    README.md 不是挺好的吗。
    knktc
    knktc
    Aug 3, 2016
    7
    用 wiki 写……
    tomczhen
    tomczhen
    Aug 3, 2016
    8
    之前用的 hexo 在内网搭了个,利用 git hook 做的自动部署更新。后面用了 gitlab 的 wiki ,然后创建了一个仓库放一些交流文档。

    虽然目前只有我一个人写就是了。
    ThomasChan
    ThomasChan
    OP
    Aug 3, 2016
    9
    @bibizhang 😂 那还不至于
    hpeng
    hpeng
    Aug 3, 2016 via iPhone
    10
    领导说什么就什么啦, word 很聪明的,你用 md 写,生成 pdf ,转换成 word 。
    neil90
    neil90
    Aug 3, 2016
    11
    我用 Pages
    iyaozhen
    iyaozhen
    Aug 3, 2016 via Android
    12
    用 word 。有统一模板
    office for Mac 很好用呀, markdown 你都会 word 还有啥难的啊
    scnace
    scnace
    Aug 3, 2016 via Android
    13
    md->pdf->word +1
    cxbig
    cxbig
    Aug 3, 2016
    14
    技术文档一律 Markdown 。可放项目 /docs/目录或独立 repo 。至于 SVN 还是 Git 无所谓。
    21grams
    21grams
    Aug 3, 2016
    15
    我觉得用 word 挺好的,文档是给别人看的,你不能光自己一个人 high 。
    zhouxuchen
    zhouxuchen
    Aug 3, 2016 via iPhone
    16
    文档放禅道,用的好像是 ueditor ,挺蛋疼的
    nisekoi
    nisekoi
    Aug 3, 2016 via iPhone
    17
    apidocjs 自动生成
    yjxjn
    yjxjn
    Aug 3, 2016 via iPhone
    18
    IBM notes
    Tneciv
    Tneciv
    Aug 3, 2016 via Android
    19
    本来我一直用 gitbook 写 然后生成 html 给出去 然而 换了新领导 说这样的文档显得不专业 要用 word 写完转成 pdf …
    我真的是没话说 再结合其他事情 已经准备走了…
    changqingshuya
    changqingshuya
    Aug 3, 2016 via iPhone
    20
    为啥不用 wiki
    ThomasChan
    ThomasChan
    OP
    Aug 3, 2016
    21
    @changqingshuya 审计公司太 low ,人家觉得有 word 文档才是专业的, 233333
    AsaMyth
    AsaMyth
    Aug 3, 2016 via Android
    22
    之前在制造业,用开目系列。。
    rashawn
    rashawn
    Aug 3, 2016
    23
    写代码的时用标签夹在里面 然后生成的时候单独调出来 估计不难
    BUPTGuo
    BUPTGuo
    Aug 3, 2016
    24
    既然版本控制,为什么不 wiki ,也导出 word
    neosfung
    neosfung
    Aug 3, 2016
    25
    latex
    LINAICAI
    LINAICAI
    Aug 3, 2016
    26
    应该用 Markdown 工,随便转 work 和 pdf
    sheep3
    sheep3
    Aug 3, 2016
    27
    有个 wiki 平台,忘记叫什么了
    exoticknight
    exoticknight
    Aug 3, 2016
    28
    md
    9hills
    9hills
    Aug 4, 2016 via iPad
    29
    word 加 svn 这个组合太奇葩了吧
    wellsc
    wellsc
    Aug 4, 2016 via Android
    30
    我司也是 svn+ word …
    kneep
    kneep
    Aug 4, 2016 via iPhone
    31
    越大越土,肯定是 word 啦
    CodingPuppy
    CodingPuppy
    Aug 4, 2016
    32
    你确定他是 tech leader ?
    tinyproxy
    tinyproxy
    Aug 4, 2016 via iPhone
    33
    confluence
    ThomasChan
    ThomasChan
    OP
    Aug 4, 2016
    34
    @tinyproxy 我们之前也用 confluence ,我昨天试用了下 pages 还挺好使的😂
    uxstone
    uxstone
    Aug 4, 2016
    35
    这个得看公司是做什么的吧,
    有的项目不需要频繁的版本更新,接口什么的基本不变动,用 word 也无所谓了
    但如果文档更新频繁,还用 word,那就是在作死....


    不过讲真,用 word 文件保存的真的很 low,
    pdf 格式的都比 word 好!
    domty
    domty
    Aug 4, 2016
    36
    用 word...
    写麻烦,读起来更麻烦。

    wiki 什么的不就挺好吗
    pljhonglu
    pljhonglu
    Aug 4, 2016
    37
    有道云协作~支持 markdown~
    tinyproxy
    tinyproxy
    Aug 4, 2016
    38
    @ThomasChan 复制粘贴图片实在不能太爽,之前拿 markdown 写过几年,每次需要插入图片都是先传图床粘贴外链,这一套操作下来我都快忘记我刚才要写啥了。
    oska874
    oska874
    Aug 4, 2016
    39
    word,还必须用公司模板。
    chilaoqi
    chilaoqi
    Aug 4, 2016
    40
    Google 全家桶。当然用 Google docs 了啊。
    Hant
    Hant
    Aug 4, 2016
    41
    Pages 不能用吗
    zhaojames077
    zhaojames077
    Aug 4, 2016 via iPhone
    42
    文档用 markdown 写,用 mkdocs 做展示;文档传到 GitLab ,通过 git hook 自动更新 mkdocs 文档目录。
    kxxoling
    kxxoling
    Aug 4, 2016
    43
    Sphinx + ReadTheDocs
    konakona
    konakona
    Aug 4, 2016
    44
    markdown (对技术)+wiki(对普通)
    exch4nge
    exch4nge
    Aug 4, 2016
    45
    正式点的技术文档,如什么需求分析、概设、详设之类的,用 word ;其余用啥都行,喜欢 reStructuredText 。

    话说楼里好多用 word 就要跳槽的, word 怎么就遭嫌弃了,用好 word 的样式表,还是能够写出漂亮的文档的, word 也有修订之类的功能,协作起来也不错。
    xiaonengshou
    xiaonengshou
    Aug 4, 2016
    46
    用 word 没毛病啊。
    ikaros
    ikaros
    Aug 4, 2016
    47
    word 好像不是纯文本吧? SVN 能追踪改动?
    ThomasChan
    ThomasChan
    OP
    Aug 4, 2016
    48
    @ikaros 二进制,并不能追踪,目的可能是为了公司审计用...
    A07de21s
    A07de21s
    Aug 4, 2016
    49
    用 MarkDown
    BlueMeow
    BlueMeow
    Aug 4, 2016
    50
    @ikaros 可以用外置工具提取字符串的,这样就可以做 diff 了
    mengzc
    mengzc
    Aug 9, 2018
    51
    公司如果有内部在线的技术文档平台那用 MD 写是不错的,不然技术文档 word 或者 pdf 格式还是最佳的,便于发送和阅读,尤其是对图片的支持,产品的技术手册图文并茂是必须的。
    balabalaguguji
    balabalaguguji
    Oct 30, 2019
    52
    推荐你试下易文档,我用过最好的一个: https://easydoc.top
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1687 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 108ms · UTC 05:27 · PVG 13:27 · LAX 21:27 · JFK 00:27
    ♥ Do have faith in what you're doing.