Document 360: #1 Knowledge Base Software
Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,400+ subscribers

Search results

Document 360: #1 Knowledge Base Software

My DITA quick reference guide (QRG)

by Tom Johnson on Jul 30, 2014 •
categories: dita

My DITA quick reference guide, or DITA QRG, is available on my menu bar and here: https://idratherbewriting.com/ditaqrg/. This DITA QRG consists of my own notes for working with DITA.

DITA quick reference guide
My DITA quick reference guide

Why create this quick reference guide? There's a lot to know about DITA. If you look at the DITA 1.2 spec there are many, many elements -- it can be overwhelming when trying to start out. Additionally, I think DITA could benefit from having more information available online.

The information in my DITA QRG is condensed into short, more code-based examples of the various elements. Right now I have about 30 topics, and I will continue to add to it as needed. Also, I focus on DITA in the context of OxygenXML, which is the main editor I'm using to structure my DITA content. (The editor isn't always relevant in the topic descriptions, but sometimes it is.)

My DITA quick reference guide has comment capability at the bottom of each topic. If you have suggestions, corrections, additions, etc., please let me know. Benefiting from your insight is why I decided to publish my notes on the web. I hope to learn from people more seasoned with DITA so that I can adopt best practices early on.

Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 5,400+ subscribers

follow us in feedly

About Tom Johnson

Tom Johnson

I'm a technical writer based in the San Francisco Bay area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.

Comments