Technical Writer Toolbox -- DITA

Dita logo

Darwin Information Typing Architecture, or DITA is a common requirement we'll see while browsing through the job description of technical writer or information architecure. But would it be really helpful in building up career? Is it worth to invest time or even money to learn? How difficult to learn it? Hopefully this article would contribute a little bit to your decision making.


What is DITA?

This can be a good and short definition: DITA is a single-source documentation management strategy based on XML architecture. It is for designing, writing, managing, and publishing documentation for both printed and web outputs.

So here is the key features:
It is a single-souce strategy for managing documents
It is based on XML code
It involves in the whole documentation lifecycle
It produces outputs for different purposes

Single-source Strategy
One of the greatest thing of DITA is single-source editing, or content reuse. Content reuse allows us to attach a certain piece of information to multiple documents, making the maintenance more efficient, and keep the outputs consistent.

XML-based Structure
XML has many advantages, such as using human language, easy to code, and extendable.

Whole Lifecycle Involving
Adopting DITA is not about choosing a word editor. It is about a concept that starting from the begining of the designing stage, and requires us to keep on the rules and writing guidlines to ensure a satisfying output and to make the maintenance easier.

Multi-purposed Output
The same piece of content can appear in multiple places, for example in an installation manual, a marketing flyer, or on a website. We are able to manage all of them on one point with the DITA structure.


Why learning it?

Though the description of DITA sounds good, but when it comes to a point to decide if I learn it or not, I need some more realistic material to weigh in. Most of our consideration on this topic is:

Is it necessary in real working environment?
Is it required on the job market?

It is quite necessary. It improves technical writing efficiency
DITA can make great contribution to the efficiency and consistency in technical writing by creating and editing the contents on one single file. For example when it comes to an update on version ID, and you have 10 documents contain this version information, instead of update the documents 10 times, you update on one document, from which the other 9 refers this information with DITA.

Single-source and Content reuse

Many employers require it. It is useful in job seeking
Tech companies today are paying efforts on building a huge variety of documentation for their product to meet different purposes. The top documentation management companies all have employed some management strategies that is suitable for their product development process, such as DITA and Docs-like-code. So knowing DITA is a big advantage when looking for a job.


How to learn it?

Since DITA is actually a mixture of a coding structure and a managing concept, we may get to learn about DITA by two thing: XML architecture and DITA concept. I would recommand to learn about the XML first, because it where this concept is build on.

For learning XML, there are many free online tutorials available. Just follow one and practice on real coding.

For learning the concept, not many tutorial teach about it, but you may find good books and bloggers written by experienced technical writers discuss about it. Here are some of my recommandation:
Book
DITA Best Practices: A Roadmap for Writing, Editing, and Architecting in DITA
Blog
TC互联技术传播和技术写作社区
莉莉邓 

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,837评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,551评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,417评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,448评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,524评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,554评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,569评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,316评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,766评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,077评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,240评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,912评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,560评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,176评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,425评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,114评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,114评论 2 352

推荐阅读更多精彩内容