用 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 的格式其实已经太复杂了,很多功能用不上。

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

11853 次点击
所在节点    程序员
66 条回复
Shingekinoshinji
2019-06-20 07:49:26 +08:00
用 latex 的话可以用 lyx 达到所见即所得的目的
shooter556
2019-06-20 08:10:05 +08:00
高级程序员每天最重要的工作是画 ppt
md 能画 ppt ?
ppt 不画出花来能唬住客户?
FrankHB
2019-06-20 11:00:38 +08:00
@shooter556 直接用 ppt 画 ppt 的基本是电脑中级高手。高级程序员里有不少各路奇葩玩意儿转 pdf 再转 ppt 的……
xmsz
2019-06-20 21:52:49 +08:00
如果只涉及开发,Markdown 足以
如果涉及整个团队,肯定要线上第三方
如果涉及整个团队,又不能线上,可以使用第三方部署内网
如果涉及整个团队,不能线上也不能内网部署,那还是自己想用啥就用啥,别强求更浪费时间,大家还不乐意
PythonKGB
2019-07-25 10:31:01 +08:00
你们这完全是给自己增加工作障碍。
我就纳闷了,技术文档怎么就不能用 word 写了呢?格式通用,任何人任何电脑都能打开,再复杂的图文混排,就没有解决不了的。
反观 markdown,学习成本不说,你一堆 MD 文档,客户用户手册用这个?外部沟通用这个?还得给各个部门同事安装 md 应用去?
别为了自己的想法,给别人找事儿。
touno
2020-08-13 10:04:55 +08:00
说了那么多,让程序员搞一个 CMS 出来就 OJBK 了~直接内容在 CMS 里面编辑发布,HTML 也可以呈现出很多东西,当然要好看还得看前端怎么去搞这些,很多样式都是要靠 CSS 和 JS 渲染的,但是 HTML 自带的足以应对你们普通的文档了。

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

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

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

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

© 2021 V2EX