Markdown是一种轻量级标记语言,创始人为John Gruber。它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的HTML文档。这种语言吸收了很多在电子邮件中已有的纯文本标记的特性。由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,许多公司和个人都广泛使用Markdown来撰写帮助文档或是用于博客上发表文章。
DITA 是“Darwin Information Typing Architecture”(达尔文信息类型化体系结构)的缩写。它是基于XML的体系结构,用于编写、制作、交付面向主题的信息类型的内容。DITA的单源内容可以通过不同的方法进行重用,生成不同的交付内容。由于DITA过去用于大型技术手册的编写、管理和交付,它能够满足所有可能呈现给读者的信息发布类型的要求。DITA可用于技术手册、交互培训,教材、标准、报告、商业文档、贸易书籍、旅游和自然指南等书籍的编写。
什么时候应该使用Markdown来写文档,什么时候使用DITA进行结构化写作呢?以下是两种方法的比较:
1. 长处
Markdown
-
快
-
易学易上手
-
与代码系统集成在一起,如Git
-
方便开发人员协作(使用Git流程)
DITA
-
内容重用
-
多产品管理
-
更广的用户协作
-
稳定的生态
2. 短处
Markdown
-
有限的语义表达能力
-
有限的元数据能力
-
有限的PDF输出格式控制能力
-
在生成最终输出前,缺乏强有力的内容验证能力
-
难以与非技术人员协作
-
不稳定的生态
DITA
-
系统实现比较难
-
工具需求
-
生态成长缓慢
3. 适用场景
Markdown
-
单一的产品
-
单一的读者
-
单一的语言
-
单一(有限的)的输出格式
-
简单的元数据需求
-
适合开发产品的早期
DITA
-
内容有许多依赖
-
多产品共享内容
-
多种类型的读者
-
多语言
-
复杂的输出需求
-
很多元数据需求
-
适合成熟的产品
4. 总结
Markdown
Markdown使小型团队能快速投入运行并适合基于云的产品。但随着内容需求随着时间的推移而增长,内容重用和单一来源功能的必要性不容忽视。
适合的场景包括:邮件、博客、写书、笔记、基本的网站内容。
DITA
如果需求是针对一个拥有广泛产品、其变体、快速增长的信息库、多种输出以及对内容重用的强烈需求的大型企业,那么DITA是理想的选择。
替换周期长,一般上了DITA系统,它会为公司提供10年以上的价值。