V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
tctc4869
V2EX  ›  程序员

如果要写一个展示复杂效果的文档,用什么软件比较好?

  •  
  •   tctc4869 · 2020-06-16 11:27:36 +08:00 · 5097 次点击
    这是一个创建于 1619 天前的主题,其中的信息可能已经有所发展或是发生改变。

    项目开发完了,免不了要写文档,例如开发文档,或者软件使用说明书。常用的基本都是 word 文档,但是如果要展示复杂的效果。

    例如与图相关效果展示,如点击文档中的一个图片,进行缩放,播放文档中的一个 gif 。如果文档内容展示模型图,比如流程图,思维导图,用例图,还能折叠展开。word 文档怎么做到这一点?能做到么?

    如果要实现如上复杂效果展示的话,有哪些软件能做到?当然 word 文档,可以超链接,但是客户端没有那些模型图软件怎么办?

    或者考虑用 html 来写文档?可 html 手写有点麻烦,如果要展示比较复杂的效果,只能考虑 js 插件。这个有比较好的 html 文档编写软件么,能像 markdown 一样编写 html,又能插入特效 html,js 代码?

    第 1 条附言  ·  2020-06-16 13:30:44 +08:00
    支持 html,pdf 导出
    第 2 条附言  ·  2020-06-17 08:37:47 +08:00
    有人说过 ppt,ppt 可以的确可以,但是 ppt 有个问题,就是它的目录分类不如 word,也就是所谓的左侧菜单栏,ppt 的目录分类的左侧菜单只有 1 一级,没有两级,而且目录项似乎只能是图片
    42 条回复    2020-06-18 12:54:31 +08:00
    tlxxzj
        1
    tlxxzj  
       2020-06-16 11:47:31 +08:00
    confluence 了解一下
    anofac
        2
    anofac  
       2020-06-16 11:51:18 +08:00   ❤️ 3
    语雀
    tctc4869
        3
    tctc4869  
    OP
       2020-06-16 13:14:37 +08:00
    @anofac
    能导出么?比如导出为 word ?或者 html ? pdf ?
    tctc4869
        4
    tctc4869  
    OP
       2020-06-16 13:43:06 +08:00
    @anofac 我试用了一下,感觉可以,但是没有导出为 html,或 pdf 功能,
    raaaaaar
        5
    raaaaaar  
       2020-06-16 13:44:28 +08:00 via Android
    为什么不用 markdown
    tctc4869
        6
    tctc4869  
    OP
       2020-06-16 13:47:04 +08:00
    @raaaaaar 如果要展示 gif 动态图片,静态图片缩放,还有模型图,例如用例图,思维导图,流程图,以及展开折叠功能,这个有哪个 markdown 能做到么。

    最后还得导出 html,或者 pdf,因为有些文档可能要给上级或用户看。上级或用户不一定会装这些软件
    afirefish
        7
    afirefish  
       2020-06-16 13:51:21 +08:00
    showdoc
    raysmond
        8
    raysmond  
       2020-06-16 13:55:03 +08:00
    markdown 里也能写 html
    cmdOptionKana
        9
    cmdOptionKana  
       2020-06-16 13:55:47 +08:00   ❤️ 1
    我觉得你把两种文档混合在一起了,所以觉得很难实现。

    1. 介绍概念,了解大致框架、流程,简单介绍主要特点文档
    2. 包含全部细节的详细文档

    这两种分开做,思路就清晰很多。
    yuchenyang1994
        10
    yuchenyang1994  
       2020-06-16 14:35:59 +08:00
    latex ?
    AreYou0k
        11
    AreYou0k  
       2020-06-16 14:38:00 +08:00
    PPT
    annielong
        12
    annielong  
       2020-06-16 15:00:55 +08:00
    ppt,epub,要么就手写 html 放网上,直接打开看,
    raaaaaar
        13
    raaaaaar  
       2020-06-16 15:46:52 +08:00 via Android
    接口文档还要画思维导图什么的,应该分开吧,后者更像设计文档啊
    tctc4869
        14
    tctc4869  
    OP
       2020-06-16 16:29:10 +08:00
    @annielong 手写 html 太慢了,有便捷的方法么?如果要说是 markdown,写完导出 html,那有绘图有功能的 markdown 软件么?绘制流程图,思维导图的。
    tctc4869
        15
    tctc4869  
    OP
       2020-06-16 16:31:32 +08:00
    @raaaaaar
    @cmdOptionKana
    不是这个问题,我知道写项目文档,会分多个文档,但是,有些文档类型,用 word 不一定合适。比如播放 gif,模型图折叠展开。
    momocraft
        16
    momocraft  
       2020-06-16 16:54:58 +08:00
    用 gatsby (有 mdx,足够可定制)之类东西,当 demo site 做
    pdf 只放静态内容,加个网站链接
    PbCopy111
        17
    PbCopy111  
       2020-06-16 16:59:36 +08:00
    这个东西。。。ppt 就解决了吧。。如果不成,就 keynote 。。。
    sardine
        18
    sardine  
       2020-06-16 17:24:39 +08:00
    ppt
    jaggerjiang
        19
    jaggerjiang  
       2020-06-16 18:50:02 +08:00
    你这个情况 ppt 肯定最适合
    tctc4869
        20
    tctc4869  
    OP
       2020-06-16 20:54:59 +08:00
    @AreYou0k
    @PbCopy111
    @sardine
    @jaggerjiang
    ppt 有个问题,就是他的目录分类不如 word,很多现在很多网站 api 使用说明也没,都直接使用侧边栏菜单,有些还带展开折叠分类的
    EEEcho
        21
    EEEcho  
       2020-06-16 21:15:55 +08:00
    clf
        22
    clf  
       2020-06-16 21:21:21 +08:00
    一般情况下,软件项目文档就两种,一种是技术类文档,一种是操作说明。

    技术类文档不需要花里胡哨的,图文足够了,markdown 最好。

    而操作说明,图文结合+视频演示也就足够了。通过这两个都弄不懂怎么操作的软件,说明软件交互设计很垃圾,用户体验极差,无法低学习成本上手。
    jim1002
        23
    jim1002  
       2020-06-16 23:21:43 +08:00
    notion ?
    iloveoovx
        24
    iloveoovx  
       2020-06-16 23:50:44 +08:00 via Android
    @PbCopy111 ppt 现在功能比 keynote 强多了吧
    freezhan
        25
    freezhan  
       2020-06-17 00:10:54 +08:00
    notion + 1 虽然我试用了下放弃了,但是感觉很符合你的需求
    tsdbg
        26
    tsdbg  
       2020-06-17 04:39:59 +08:00
    @tctc4869 Typora 有 mermeit 支持,只要你别搞得太花里胡哨
    lululau
        27
    lululau  
       2020-06-17 07:35:31 +08:00 via iPhone
    markdown 本身就是 HTML 的超集
    tctc4869
        28
    tctc4869  
    OP
       2020-06-17 08:22:46 +08:00
    mermeit 是什么?
    yoonper
        29
    yoonper  
       2020-06-17 08:30:09 +08:00 via Android
    文档的话可以试试
    http://www.yoonper.com/post.php?id=115

    如果需要特殊功能可能得自己定制一下
    BingZ
        30
    BingZ  
       2020-06-17 08:59:52 +08:00
    同意 9 楼的,你把两种不同需求混一起了。
    你需要一份 PTT,仅做演示和宣讲。而产品文档就应该是静态的,不要花里胡哨,向字典看齐,事无巨细,方便查找。
    tctc4869
        31
    tctc4869  
    OP
       2020-06-17 09:18:53 +08:00
    @BingZ 你也和 9 楼一样先入为主了。开头我就写了,“例如开发文档,或者软件使用说明书”,这句话已经表达了,我已经分清楚要写多个文档了。

    ppt 的主要用途是用去讲台上讲解的,写产品操作说明书,word 比 ppt 更合适,ppt 没有 word 那样详细的目录菜单分类功能,也就是左侧菜单,ppt 的左侧菜单只有 1 级,而且还全是图片,没有文字,哪像菜鸟教程,一些 api 网页使用说明演示,都会提供带有分类分组的左侧菜单,用 ppt,我还不如直接用 word+超链接都比 ppt 好。
    JerryCha
        32
    JerryCha  
       2020-06-17 11:33:01 +08:00
    flash
    BingZ
        33
    BingZ  
       2020-06-17 11:51:09 +08:00
    @tctc4869 好吧,从你的描述看,很多人都被引导到 PTT 去了,你不觉得自己的文字表述有些模糊么?
    另外,你所指出的“不支持”的功能,仔细看看都是些“可实时互动”的动态效果。
    回到常规意义的文档本身来说,为什么需要那么多的互动?这些互动能被打印到纸上么?能转成 pdf ?在静态展示为主的传统文档里,平铺展开就足够了,快速跳转交给目录和索引去完成。动画展示的内容一律通过截图来说明。除了动画和声音外,文字和图片已经足够表达了。不需要额外软体和设备的支持。
    当然,“文档”可以包括视频资料和多媒体的互动资料。要实现这些,建议采用 html 或者 markdown 来完成。但这样的展示需要特定的软体支持,使用者才能看到效果,这是有成本的。可能做成网站形式,对用户来说使用负担最小,也较易被接受。markdown 还是太不成熟了。
    boyuanhao
        34
    boyuanhao  
       2020-06-17 14:29:35 +08:00
    目前在用语雀
    hyperbin
        35
    hyperbin  
       2020-06-17 15:20:07 +08:00 via Android
    图文排版是天坑,找不到现成的千万别自己开发
    Elissa
        36
    Elissa  
       2020-06-17 17:19:07 +08:00 via Android
    媒体(图片,动图,各种各样的图)和文字分开编写,最后一起放在 markdown 里,随便导出
    shuangya
        37
    shuangya  
       2020-06-17 17:42:56 +08:00
    你要的东西太多了,现阶段,完全满足的是手写 HTML,或者 PPT 。
    但你又嫌麻烦了,想了一下只有语雀满足。
    语雀可以导出 PDF,不能导出 HTML 。
    另外语雀的在线管理和演示功能其实都还不错,所以一般情况下也不太用得上导出。
    myCupOfTea
        38
    myCupOfTea  
       2020-06-17 18:20:49 +08:00 via Android
    markdown 就行了,至于流程图啥的,vscode 的 markdown preview 插件支持这些,写完了也可以导出成图片,pdf 或者 html
    xingyuc
        39
    xingyuc  
       2020-06-17 18:23:24 +08:00
    你要的不就是 gitlab gitbook 这类文档工具吗
    myCupOfTea
        40
    myCupOfTea  
       2020-06-17 18:57:28 +08:00
    tctc4869
        41
    tctc4869  
    OP
       2020-06-18 08:38:16 +08:00
    @Elissa 具体怎么做?
    Elissa
        42
    Elissa  
       2020-06-18 12:54:31 +08:00
    @tctc4869 先把各种图片用一写画图工具画好,再去写文字,在写文字过程中需要图片的时候直接插入
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1073 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 572ms · UTC 19:01 · PVG 03:01 · LAX 11:01 · JFK 14:01
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.