文檔格式

文檔格式

对外

適合presentation

产品的需求是word。

如果是对外的,给其他合作公司看的,那么pdf输出,changelog,乃至可调试的环境比较重要

对内

適合版本管理

开发这边,后台我们用markdown把一些开发规范、设计方案之类的都用markdown。

wiki

如果是对内的,自己备查或者指导新人的,那么日常维护方便,和代码结合紧密比较重要

texmacs这个软件很赞,wysiwyg(所见即所的),格式是文本(易于版本管理),快捷键还算方便、一些插入图表的特性不错、容易输出各种格式(pdf、ps、html...),体积还算小巧(几十兆)

我们目前强制要求使用word的审阅功能, 有什么变更一目了然, 再配合版本控制工具, 查看两个版本之间的差别很轻松。

markdown什么的虽然可以通过版本控制来查看变更, 但是感觉是给开发人员用的, 对于非开发人员不友好。

写表格的话可以试试 reStructuredText, 比起Markdown更适合于写长篇说明文档。 这里有一些讨论: http://stackoverflow.com/questions/34276/markdown-versus-restructuredtext

最近也在思考这个问题。

我最近很喜欢用彩色表格,表示不同的状态,也在尝试不同的表现方式。比如删除的功能用红色块,新加的功能用橙色块等等。或者不同的部位用不同的色块。包括字体。所以我一般都输出PDF文档,避免在office上出现诡异的问题。

MD我觉得写一些简单的log,update,或者一些特别轻便的小需求可以。纯文本看起来不够漂亮,而且字体也不能达到满意的效果。

http://asciiflow.com/

没有工具能够兼顾所有需求,所以分不同场景选用合适的工具才最好

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

https://www.jianshu.com/p/37583edb9546

TeXmacs:一个真正“所见即所得”的排版系统

posted on 2020-05-18 00:32  cutepig  阅读(252)  评论(0编辑  收藏  举报

导航