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

2020-06-16 11:27:36 +08:00
 tctc4869

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

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

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

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

4893 次点击
所在节点    程序员
42 条回复
tlxxzj
2020-06-16 11:47:31 +08:00
confluence 了解一下
anofac
2020-06-16 11:51:18 +08:00
语雀
tctc4869
2020-06-16 13:14:37 +08:00
@anofac
能导出么?比如导出为 word ?或者 html ? pdf ?
tctc4869
2020-06-16 13:43:06 +08:00
@anofac 我试用了一下,感觉可以,但是没有导出为 html,或 pdf 功能,
raaaaaar
2020-06-16 13:44:28 +08:00
为什么不用 markdown
tctc4869
2020-06-16 13:47:04 +08:00
@raaaaaar 如果要展示 gif 动态图片,静态图片缩放,还有模型图,例如用例图,思维导图,流程图,以及展开折叠功能,这个有哪个 markdown 能做到么。

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

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

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

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

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

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

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

© 2021 V2EX