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

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

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

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

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

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

5358 次点击
所在节点    程序员
42 条回复
EEEcho
2020-06-16 21:15:55 +08:00
clf
2020-06-16 21:21:21 +08:00
一般情况下,软件项目文档就两种,一种是技术类文档,一种是操作说明。

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

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

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

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

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

https://yangjunhui.monster/t/681976

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

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

© 2021 V2EX