用 markdown 文档完全替代 word 文档的可行性

2019-06-18 20:09:25 +08:00
 shijingshijing

目前公司正在讨论后续文档管理的策略,在方案选型的时候,在 word 和 markdown 之间有些犹豫。

主要是分析了现有文档管理情况,然后考虑新项目的文档如何管理。大致情况如下:
1.硬件团队的嵌入式的代码直接使用文本文件的 README,甚至用 ASCII 化简图(有非常 nb 的老工程师在驱动代码文件头部用 ASCII 拼除了芯片引脚和寄存器移位的示意图,这种只能膜拜,绝壁是不能动的)。
2.软件团队内部主要使用 Sphinx,部分 java 代码相关的用 javadoc。
3.系统架构、需求方面以 word 文档为主,有不少内嵌的 UML 截图,visio 截图。
4.测试文档也是用的 word 编写,测试用例主要是 excel 模板管理,测试报告也是 excel 套 word 模板生成的,一边测一边填 excel,测完运行一个宏直接生成。
5.用户手册也是用的 Word 模板,然后人工编写。
6.各个部门内部有一些比较好的经验分享类的文章,也是用 word 编制的,很多都是图文并茂。

现在的主要问题是这些文档都是独立的文档,公司想把这些文档做成某种能够在线检索的知识库,同时还要考虑以下问题:
1,去微软化,彻底替换 word,而且不考虑 WPS,文档格式需要能够完全透明,根据自己的需要检索、解析或者批量处理,能用 git 进行版本管理。
2,显示输出要保持同类型 word 文档的层次和条目,不能跟以前老项目的文档看起来有很大不同,细微的差别可以接受。
3,必须能够像 word 那样在 A4 纸上分页打印输出,同时如果在线查看也能像 HTML 那样连续输出一整篇。
4,能够导出成 pdf 作为离线的电子版发布。
5,一篇文章作为一个文件,图片必须内嵌到文章里,不能以链接的方式单独存放。
6,支持离线编辑,支持图文混和编辑,所见即所得。

我已经在 word 上面做了大量尝试,包括使用 sharepoint 来进行版本管理,这套方案还是太厚重了,sharepoint 的版本管理和 git 还不太一样。另外在网上看见有方案是用 BASE64 编码图片然后内嵌到 markdown 文档里面,不知道较大的图片是否可行。文档格式方面其实没有特别复杂的需求,刚性的主要是图文混排,分段,加粗加黑,缩进这些,word 和 wps 的格式其实已经太复杂了,很多功能用不上。

大家有没有其他好的实践,希望能分享一下。

11442 次点击
所在节点    程序员
66 条回复
dalieba
2019-06-18 22:40:02 +08:00
LibreOffice 来了解一下
dalieba
2019-06-18 22:43:45 +08:00
这个可以依靠 Libo PlantUML 插件在文档里边直接用 UML 作图,须要外接 Graphviz 程序。
https://bbs.libreofficechina.org/thread-2188-1-1.html
dalieba
2019-06-18 22:58:28 +08:00
Typora 通吃 Markdown/LaTeX,值得一用。
tennc
2019-06-18 23:16:51 +08:00
tennc
2019-06-18 23:17:05 +08:00
Typora 通吃 Markdown/LaTeX,值得一用。 @dalieba +1
shijingshijing
2019-06-19 00:42:45 +08:00
@dalieba 没用过这个 Libo,我们的 UML 都是在 Enterprise Architect 里面弄的,功能强大。Typora 也在用,感觉离完全顶替 word 还差一截。。。
shijingshijing
2019-06-19 00:46:29 +08:00
@love 不可能叫做机械和模具的工程师用用 Beyond Compare 就已经不错了,vim diff 什么的太难为人家了,html 估计都得熟悉熟悉才行,负责客户培训的小 mm 也不可能写 html 的。图文混排和所见即所得是刚需。
kvker
2019-06-19 00:49:01 +08:00
本质上算是 html 替代 office ?
shijingshijing
2019-06-19 00:52:02 +08:00
@kvker 不一定是 HTML,但是应该算是 Markup language 替代不透明的 doc 文档。
zhuangzhuang1988
2019-06-19 00:55:00 +08:00
先比的上 reStructuredText 再说吧。
拿个小砍刀去和导弹比。
secondwtq
2019-06-19 01:14:13 +08:00
... Markdown “替代” Word 这种话也就只有程序员能说了

这俩(或者说 Word,TeX 这俩和其他标记语言)根本就不是一个定位的东西,没法拿来比的。在功能性上,Word、TeX 和其他标记语言有十分巨大的 gap,并且这个 gap 中间是没有别的选择的,意思是你要么用 ASCIIDoc/reStructuredText,要么用 Word/TeX,要么妥协你自己的需求。( HTML 勉强能比,但是我觉得你都用 HTML 写东西了,干嘛不用 TeX ?)

你把这些标记语言给拿给非程序员,人家没准会选 BBCode/Discuz! 代码,不为别的,起码人家功能强啊(就算如此好像还是没有解决最基本的图文混排)

另外倒是有一些可视化编辑器很有意思,不过现在这年头的年轻人喜欢什么都往 Web 上面搬,这个歪风邪气本身就喝楼主要求离线的需求是相悖的 ... 所以¯\_(ツ)_/¯
secondwtq
2019-06-19 01:25:28 +08:00
@secondwtq 据我所知目前在这个 gap 之间的只有这么几种选择:Markdown 的各种魔幻扩展,PHP,Madoko

PHP 还有的救,Madoko 就是 TeX,Markdown 扩展跟 TeX 比就是这张图: https://gss0.baidu.com/-fo3dSag_xI4khGko9WTAnF6hhy/zhidao/pic/item/c9fcc3cec3fdfc033cfbce23d23f8794a5c226ad.jpg

欢迎举出反例,因为我发现所谓 Markup language 的世界真的太单调了,我非常愿意了解还有几个能打的
haimall
2019-06-19 01:37:50 +08:00
看了半天 discuz 论坛最合适了😂😂😂
geelaw
2019-06-19 02:42:40 +08:00
呃 首先 docx 是标准化的,可以解压缩查看 XML。其次,自动化的检索等任务可以用 COM。
AX5N
2019-06-19 04:17:27 +08:00
标题的主语是谁?
widewing
2019-06-19 05:10:53 +08:00
要不。。eml ? 邮件客户端都能打开,支持可视化排版,图片编码为 ascii,完美标准化。。
fannas
2019-06-19 05:23:52 +08:00
看了一遍,latex 完全满足要求。
fannas
2019-06-19 05:25:00 +08:00
@fannas sharelatex 和 over leaf 了解一下啦
silentstorm
2019-06-19 05:27:39 +08:00
docx 已经全部是 xml 定义了,可以开发一个解析 docx 的程序。
luozic
2019-06-19 05:36:10 +08:00
你怕是不知道 word 早就做了规范化文档方案 ,内容都是存 xml 的。 业界好几种索引和检索 word 文档的搜索引擎,商业得好几个,免费还能私有部署的自己找找

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

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

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

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

© 2021 V2EX