V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
ThomasChan
V2EX  ›  问与答

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

  •  
  •   ThomasChan · Aug 3, 2016 · 10127 views
    This topic created in 3566 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
        1
    naver1  
       Aug 3, 2016
    都要求 word 了。。。你就别想那么多了~~~
    ixiaozhi
        2
    ixiaozhi  
       Aug 3, 2016
    我用 rap
    bibizhang
        3
    bibizhang  
       Aug 3, 2016
    换我就辞职了
    ahcat
        4
    ahcat  
       Aug 3, 2016
    用百度的 UEditor 写,然后按照公司的文档规范,通过脚本转换成指定样式的 Word 文档、 PDF 文档。
    daya
        5
    daya  
       Aug 3, 2016 via Android
    用键盘(滑稽)
    checgg
        6
    checgg  
       Aug 3, 2016
    README.md 不是挺好的吗。
    knktc
        7
    knktc  
       Aug 3, 2016
    用 wiki 写……
    tomczhen
        8
    tomczhen  
       Aug 3, 2016
    之前用的 hexo 在内网搭了个,利用 git hook 做的自动部署更新。后面用了 gitlab 的 wiki ,然后创建了一个仓库放一些交流文档。

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


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

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

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