bell notificationshomepageloginNewPostedit profile

Topic : Re: Any advice on how to learn DITA for technical writing? My situation is such that I will be looking for a new job next week as this contract ends. For a tech writer, it is good to have - selfpublishingguru.com

10% popularity

For a more hands-on introduction, you might consider downloading and installing the DITA Open Toolkit. After you have set up the toolkit, you can:

Take a look at the DITA XML source for a real publication, namely the DITA Open Toolkit user's guide. The source is located in the docsrc folder, but you can also access it on GitHub.
Use this source to build the final output, for example, HTML or a PDF. To do this, see Rebuilding the DITA-OT documentation (or Chapter 20 in the PDF version).
Open a .dita topic file. Try to find that topic in the document by searching for its title. Notice how the XML follows a specific topic structure. In DITA, a topic is the basic unit of authoring.
Open a .ditamap file and compare what you see to the table of contents in this publication. Notice how it uses DITA map elements to organise a series of topics.
Make a small change to the title of a topic (perhaps after making a backup copy) and rebuild the publication. Notice how your change is rolled into the new version of the document.
At this point, you'll realise that it could be quite a challenge to write a document in DITA without some additional tool support. This is where "DITA-aware" tools such as Oxygen XML Author come in to provide editing support. Note that Oxygen comes bundled with the DITA Open Toolkit. There is a list of tools that use the DITA Open Toolkit on dita-ot.org. See also this list of DITA-related software tools.

Section 2.2.1.2 of the Darwin Information Typing Architecture (DITA) Oasis standard contains more on the benefits of topic-based authoring.

For more examples of DITA-based authoring, check out the list of Open Source DITA Collections on oasis-open.org.


Load Full (0)

Login to follow topic

More posts by @Jamie945

0 Comments

Sorted by latest first Latest Oldest Best

Back to top