WeHack BBS
当前最好的文档格式是什么? - 可打印的版本

+- WeHack BBS (https://bbs.wehack.space)
+-- 版块: 其他讨论 (https://bbs.wehack.space/forum-10.html)
+--- 版块: 自由讨论区 (https://bbs.wehack.space/forum-13.html)
+--- 主题: 当前最好的文档格式是什么? (/thread-89.html)



当前最好的文档格式是什么? - vimacs - 10-24-2019

在水木上看到一个帖子《chm为什么没流行起来?》,觉得这个话题挺有意思的,想讨论一下。

chm的主要优点是单文件,有快速索引和查找功能,缺点是它是私有格式(不过有自由的阅读器),并且好看的chm文档似乎难制作。帖主举了Python文档的例子,他以此说明chm文档挺方便的,但是chm文档在xchm查看器中的质量远远不如pdf和html的版本。而且由于chm是二进制的打包格式,里面有可能隐藏恶意的js(当然,阅读器可以禁用它)。epub应该算是chm的自由替代品吧,但是帮助文档也很少用这种格式。

相对来说,分离的html更通用一些。在sphinx之类的文档工具的帮助下,生成的html文档也有搜索功能。此外,html文档可以做成在线版本,对于软件发布者来说更方便。

写文档现在一般都是用纯文本了,带上reStructuredText/markdown的格式,可以很容易地生成各种格式的文档。传统的man page也是从纯文本生成出来的。

pdf适合打印,但是可能的确不适合阅读,特别是宽屏的桌面计算机看竖排的pdf挺吃力的。