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

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

11831 次点击
所在节点    程序员
66 条回复
wweir
2019-06-19 07:35:37 +08:00
解决了技术问题,再来考虑一下人?人、企业的接受能力,才是 office 这套软件最强的生命力
exip
2019-06-19 08:33:10 +08:00
用 libreoffice,除非你司都是程序员才有可能都用 markdown
FrankHB
2019-06-19 08:44:42 +08:00
不同文档面向的用户和维护需求不同,为什么要强求使用相同的实现?
(要不需要编辑,直接 pdf 都行。)
要强调检索那得结构化数据,都不应该保证存的是“文档”。
去微软化?自己实现个 ISO/IEC 29500 ?
Stevenv
2019-06-19 08:48:34 +08:00
顶多只能技术部用 markdown
FrankHB
2019-06-19 08:50:12 +08:00
@secondwtq 能打的,是指不“单调”么? SGML 和 DSSSL 了解一下?(

@exip 要表格什么的 md 就没救的……看这需求是没跑了。
程序员也干不过 markdown 方言兼容和残废(比如 Bitbucket wiki )问题。
xuanbg
2019-06-19 09:11:21 +08:00
除了不能直接画图外,都没有问题。我们直接在 git 项目的 readme.md 里面写接口文档已经好几年了。
dalieba
2019-06-19 09:33:06 +08:00
@haimall #33 还有 phpbb、Discource
@shijingshijing #26 那就来看看 http://url.slat.org/dwl-tw
mapper
2019-06-19 09:55:06 +08:00
word 是不可能被取代的,更大众化, 同样 markdown 对于技术人员来说也是无法取代的
FrankHB
2019-06-19 10:19:46 +08:00
@mapper 不,markdown 的竞争对手和备胎明显更多,个人使用现在能直接上车的就有不少。技术人员只会用 markdown 和某些服务只支持 markdown 会是个问题,但不会是长期的不可实现替代的问题。反过来,Word 不说实现,光是文档规格就别想随便整个替代,甭管你是不是技术人员。
mooncakejs
2019-06-19 10:33:35 +08:00
markdown 太简陋了。
liu19931020
2019-06-19 11:45:38 +08:00
Sphinx 用 reStructedText 挺好的
qqjt
2019-06-19 11:47:24 +08:00
别替代了,老老实实支持多种文件格式,txt、word、markdown 等等。
snw
2019-06-19 12:51:54 +08:00
Word 是非专业通用文本编辑器中最好用的,功能很全。

但一旦你想做些专业的事情就会发现 Word 真是 bug 一大堆,样式、字体、表格、修订等等,经常莫名其妙就崩坏。
littlewing
2019-06-19 12:56:45 +08:00
confluence
l1ve
2019-06-19 14:18:18 +08:00
onlyoffice 不考虑一下?
lzhCoooder
2019-06-19 14:25:17 +08:00
LaTeX,全公司用一套大模板,每个部门在上面微调一下,以后每个人写起来就像在做填空题,并且格式完美一致,除了你说的所见即所得,其他需求都是最基本的功能
qianji201712
2019-06-19 15:07:26 +08:00
居然用 word 写技术文档 = =(求别碰),MarkDown 标配吧
jdhao
2019-06-19 15:20:48 +08:00
@lzhCoooder 表格就比较麻烦,另外 LaTeX 运行出错,debug 也比较麻烦
liu19931020
2019-06-19 15:26:24 +08:00
@lzhCoooder 你们的表格做的累不累
hzgit
2019-06-19 20:46:03 +08:00
confluence +1

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

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

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

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

© 2021 V2EX