Technical Writing: How to Write Using DITA XML
3.9 (83 ratings)
Course Ratings are calculated from individual students’ ratings and a variety of other signals, like age of rating and reliability, to ensure that they reflect course quality fairly and accurately.
271 students enrolled

Technical Writing: How to Write Using DITA XML

How to Become a Modern and Successful Technical Writer Using DITA XML
3.9 (83 ratings)
Course Ratings are calculated from individual students’ ratings and a variety of other signals, like age of rating and reliability, to ensure that they reflect course quality fairly and accurately.
271 students enrolled
Last updated 3/2020
English
English [Auto]
Current price: $139.99 Original price: $199.99 Discount: 30% off
5 hours left at this price!
30-Day Money-Back Guarantee
This course includes
  • 7 hours on-demand video
  • 14 articles
  • 13 downloadable resources
  • Full lifetime access
  • Access on mobile and TV
  • Assignments
  • Certificate of Completion
Training 5 or more people?

Get your team access to 4,000+ top Udemy courses anytime, anywhere.

Try Udemy for Business
What you'll learn
  • Learn to write using DITA XML topics and maps
  • Produce documentation deliverables using Oxygen Author tool
  • Reuse on maps level (mapref), topic level (topicref), topic element level (conref) and table rows (conref - conrefend)
  • Personalized user guides based on the same DITA content using profiling (conditioning) of content
  • Create interactive images and create image maps
Course content
Expand all 87 lectures 07:09:58
+ Introduction
5 lectures 55:46
How to Use This Course?
00:50

You can open on your computer and follow the slides as you go through each learning section.

Slides Used in This Section
00:04

1.Request a trial license from the Get a Trial page: https://www.oxygenxml.com/xml_author/register.html?p=author  or from your instructor: jpdocuservices@gmail.com.

2.Start the download. Go to https://www.oxygenxml.com/xml_author/download_oxygenxml_author.html

3.Choose your OS.

4.Click on the Download button.

5.Once the download is complete, start the installation wizard and install the tool.

6.Once the installation is complete, enter your trial license key.
You are now ready with the set up of the software for this course. 

Preview 03:46

There is a good reason why DITA is so popular today. In this lecture I explain what these benefits are from the point of view of an author of software documentation and an information architect.

Preview 36:45
+ Get Started with DITA
11 lectures 01:04:22
Slides Used in This Section
00:01
Step 1: Choose Topic Type
12:47
Step 2: Create the Topic
01:22

In this lesson, I explain in more details what is a DITA map and how to use it.

Step 3: Reference the Topic in a DITA Map
05:18

In this lecture you will see how to perform the actual steps described so far.

Step 3: Demo
13:27
Step 4: Generate the Output
03:30

In this lecture you will learn how to generate the output of your DITA guide.

Step 4: Demo
04:43

What does the output look like? What are other possible choices as output you can generate using the same DITA source?

Generated Output - Review of Possible Options
14:00

So far we spoke primarily about Task topic type - after all, in structured writing this is the most heavily used topic type. At the same time, you documentation will not be complete if you do not provide additional relevant information. In this lecture, I explain 2 other DITA topic types: Concept and Reference.

Using DITA Concept and Reference Topic Types
02:15

In this lesson, you can watch the demo of the exact steps to follow to create the Concept and Reference topic types.

Demo: Creating and Referencing Concept and Reference Topics in a User Guide
06:54

Attached are the DITA source files of the demo you watched in this section. You can download these source files and play with them in your local Oxygen XML Author environment.

Sample DITA Source Files
00:05
+ DITA Elements
12 lectures 24:37
Slides Used in This Section
00:01

In this section you will learn which are some of the most common DITA elements, that you will use on a daily basis. Attached you will find the slides used in this section, in case you want to use them a reference in future.

Preview 01:41

Which are the common elements we use to create content?

Common Elements in Documentation Topics
01:42

How do the common topic elements map to DITA elements?

Corresponding DITA Topic Elements
01:32

Create some topic elements yourself!

Exercise: Use Topic Elements in a Topic
00:27

How to think about topic elements, so that it's easy to understand them?

How to Think About Topic Elements?
01:41

In this lesson, we will use a Task topic as the context in which we use DITA topic elements. We deep dive into the usage of the topic elements one by one, as they appear in a sample Task topic.

Using Topic Elements in a Task Topic
05:24

Let's recap what you have learned so far!

Let's Recap! Topic Elements in a Topic.
01:36

How to see which element to use in the context of my Task topic?

How to See Which Topic Element to Use in a Topic?
04:25

Tables are commonly used in software documentation. Which are the elements in DITA that you can use to construct a table?

Tables and Table Elements
01:29

In this lecture you will learn which are the common DITA map elements to use.

DITA Maps and DITA Map Elements
03:15

A demo of the DITA map elements using a DITA source, as explained in the previous lecture.

Demo: DITA Map Elements
01:24
+ Reusing Content in DITA
10 lectures 54:44
Slides Used in This Section
00:01
Reuse on Map Level (mapref)
10:31
A Hint on Using Maps for Organizing the Team Work
06:03
Reuse on Topic Level (topicref)
01:27
Reuse on Topic Level - Demo
01:29
Reuse on Topic Level - Exercise
00:16
Reuse on Topic Element Level (conref)
08:03
Reuse on Topic Element Level - Exercise
00:36
Reuse of Table Rows (conref - conrefend)
14:20
+ Profiling in DITA
11 lectures 01:02:41
Slides Used in This Section
00:01
Preparing the Editor to Use Profiling
04:36
Preparing the Editor to Use Profiling - Continued
10:17
Profiling a Reference to a DITA Map (mapref)
07:11
Profiling a Reference to a DITA Topic (topicref)
05:24
Profiling on a Topic Element Level
05:24
Profiling Tables and Table Elements
11:26
Generate Profiled Output
03:28
Generate Profiled Output - Example
02:21
+ Information Architecture for Technical Communicators
5 lectures 51:46
Slides Used in This Section
00:01

Learn:

- what is information architecture

- who is an information architect in technical communications world

- what is the recipe for applying information architecture principles for personalizing software documentation.

Information Architecture in Technical Communications
26:06

Learn about the information architecture framework to consider when designing your documentation development process.

Information Architecture Thinking Patter for Technical Writers
08:49

Let's look at a practical example of applying the information architecture framework on the content.

Applying Information Architecture Principles When Designing the Documentation
15:57
Exercise
00:53
+ Information Architecture for DITA Authors
7 lectures 44:05
Slides Used in This Section
00:01

Now that you know what information architecture is all about, let's get more practical. Let's find out how information architecture applies in DITA and how DITA enables you to be a better information architect.

Information Architecture for DITA Authors
01:49

What is a subject scheme map in DITA? How to use it as an information architect?

Develop the Correct Content for you DITA Subject Scheme Map
02:39

What are the benefits you will gain if you spend your time organizing the information that represents your product or corporate taxonomy?

Benefits from Using a Taxonomy: Achieve a Common Understanding
01:47

Examples of the benefits and further development.

Controlled Vocabularies, Aggregations, SEO
06:28

To create your taxonomy, you can use a mind mapping tool, such as xMind. This free tool is one of the best tools I have used to create and discuss taxonomies with the team.  To use this tool:

1. Download a free version from https://www.xmind.net.

2. Once ready with the installation, create a blank mind map.

3. Add your taxonomy terms.

Tools for Designing a Taxonomy: xMind
02:03

DITA allows information architects to govern the use of profiling values by authors. You do that by leveraging a special type of DITA map -  Subject Scheme Maps. In this lecture, you will learn more about subject scheme maps and how you can construct and use them in DITA maps.

Governance of Profiling Values using Subject Scheme Maps
29:18
+ How to Create Interactive Images in DITA
22 lectures 01:09:10
Slides Used in This Section
00:01
Why Using Graphics?
02:48
When to Use Graphics in Software Documentation?
02:58
Types of Graphics in Software Documentation
02:41
Accessibility of Graphics
07:20
Using Appropriate Colors
02:31
Typography
01:15
Remember the Style Guide!
01:16
Translation Aspects
02:08
Using Microsoft Power Point to Create a Graphic for Documentation - Part 1
03:42
Using Microsoft Power Point to Create a Graphic for Documentation - Part 2
03:06
Using Google Slides to Create a Graphic for Documentation
03:34
Other Tools to Create a Graphic for Documentation
00:15
What is Interactive Graphic? What is an Image Map?
06:17
Step 1: Create the Infographic
07:51
Step 2: Download the infographic
01:43
Step 3: Reference the Graphic as an Image in a DITA Topic
05:42
Step 4: Create an Image Map and Define Linking Targets
04:14
Step 5: Generate Output with Interactive Graphic
04:30
+ Linking in DITA
2 lectures 02:30

In this lesson you will learn how to manually create a link between two topics in DITA.

Manual Linking Between Topics
02:26
Automated Linking Between Topics
00:04
Requirements
  • You need a PC or a laptop where to install the needed software an follow the exercises in the course
  • This course is not suitable for use on a mobile device or tablet
  • Basic knowledge in technical writing is recommended
Description

Do you want to learn how to write structured documentation using DITA XML? If yes, I can help!


My name is Jordan Stanchev. I have built my career in the field of technical communications in the last 20 years.

Starting off my carrier as a Java developer, I have then become a senior technical writer and had built a career as a DITA information architect.

I have written thousands of pages of software documentation guides for administrators and for developers. The software products I have worked on are in the field of security, messaging services and development infrastructure (such as GitHub and SAP NWDI).

Today, I am a part of the team that leads the development of DITA XML-based infrastructure projects. The technical writers' community we serve is more than 1000 authors. I also chair the experts' group of our nearly 300 people strong group of DITA information architects in a Fortune 500 company.  I constantly have to write software development specifications and project documentation, in addition to the user guides information I provide.

What can I say, I have vast experience to share in structured writing and information architecture using DITA XML. And this is what I focus on in this course.

Based on my experience, what I can tell you, is that a modern technical writer looking to build his or her career in the field of technical communications, knowing DITA XML simply is a must!

You wouldn't believe how often I hear back from my students how the knowledge from this course is what made the break-through in their DITA technical writer job interview and helped them advance their career!

To achieve the ultimate career goal, all you do need is to learn writing using DITA!


Knowledge of DITA is relevant for you if you are involved in any way with software documentation as a:

- technical writer;

- information architect;

- people manager, managing technical writers in the team;

- user experience designer;

- business analyst;

- project manager;


The course 'How to Write Using DITA XML" is designed for intermediate to advanced level technical writers who want to deep dive into the capabilities offered by DITA, create complex and personalized user guides and deliver this single-sourced output using Oxygen Author tool into various delivery channels. 

It is based on the 10 days long online DITA training I've been providing to my students.

WARNING: 

It will take you around 7-8 hours from the start of this course just to go through this material! It comes with lots of various hands-on exercises, examples and advises based on my practice.

I recommend that you take one section a day at most, to avoid being overwhelmed and manage to perform each exercise described.

The course further deep dive and elaborate the basic concepts and knowledge introduced with the course 'A Quick Start to Technical Writing with DITA' and then provides more advanced details and strategies such as reuse of content and personalization of content based on profiling strategy.


Note:

If you are looking for a quick start into DITA, consider the basic DITA course 'A Quick Start to Technical Writing with DITA', which is for technical communicators, that are not yet familiar with DITA.


What will you learn?


Section 1: Introduction

By the end of this section you will able to explain:

- What is DITA;

- What are the benefits of writing software documentation using DITA;


Just spelling out the benefits of writing in DITA takes a lot of time! There are so many reasons why DITA is getting more and more popular. Today you cannot be a modern technical writer if you do not know how to write software documentation using DITA XML! It's the de facto standard XML for writing! You must know and spell out the benefits of DITA, and be sure, on a job interview you will be asked why DITA is so important.


Just to name a few:

- Based on common information types.

- It implies strict rules for writing, no matter who the technical writer is!

- Content is modularized and reusable.

- Automatically generated various outputs from the same DITA source;

- Content can be personalized, and so on.


Section 2: Get Started with DITA

By the end of this section you will be able to:

- Apply the 4 steps for creating the content of a user guide;

- Explain what is a DITA map;

- Create the 3 most frequently used DITA topics types: Task, Concept, and Reference;

- Create DITA maps;

- Reference topics in a map to construct a deliverable (user guide) using Oxygen XML Author;


Writing in DITA is easy. Do not let the diversity in tags and the huge number of DITA capabilities confuse you.

All you need to write your first guide is a strategy (what you want to deliver) and a set of simple steps to follow to construct your guide (explained in this section of the course)!


Section 3: DITA Elements

By the end of this section you will be able to:

- Name the most commonly used DITA topic elements (DITA tags);

- Describe a strategy for using topic elements in the context of a specific topic;

- Open, search through and select the needed topic elements in a topic;

- Use the list of topic elements in the context of a Task topic;


DITA comes with a huge number of tags to use. With them comes a great flexibility for writing content. But where do you start? And which elements are a "must-know" vs. "optional-to-know"? This is what you will learn in this section to get a steady start with your content.


Section 4: Reusing Content in DITA:

By the end of this section you will be able to:

- Describe the benefits of reuse;

- Reuse content on map level (mapref);

- Reuse content on topic level (topicref);

- Reuse content on a topic element level (conref);

- Reuse entire table rows (conref - conrefend);


Reuse of content on all these levels allows you to dramatically reduce the time you have to spend writing documentation. This is one of the most important benefits of DITA. 

Allow me to give you an example: you can use reuse on the topic element level to define the name of your software product as a reusable topic element. You then use this element across your entire document. Later on, when the product name changes, you update the value of the reusable topic element and it gets automatically updated in all occurrences in each and every document! Compare this to the time it takes you searching and replacing a product name in a Word document or Wiki pages!


Section 5: Profiling (conditioning) content in DITA:

By the end of this section you will be able to:

- Describe the benefits of using profiling in your content;

- Profile content on map level;

- Profile content on a topic level;

- Profile content on a topic element level;

- Profile table rows;


Today everyone talks about personalization of the user experience with the software. How about personalization of the user experience with the software documentation? 

The profiling functionality allows you to personalize the content for your target audience, without disrupting the authoring process. The personalized end-user guide is automatically generated in the end, based on the rules set by the author. Something that is close to impossible for any non-structured way of writing content in DITA happens in few clicks!


Section 6: Information Architecture for Technical Communicators

By the end of this section you will be able to explain:

- What is information architecture?

- Who is an information architect?

- What to consider to become an efficient information architect?


As of this section, we are razing the stakes! This course is not only for people who want to learn to write in DITA but also for those of you who want to grow in their careers. What's the name of the next level in technical writing? It's called "information architecture". But what is information architecture? What are you supposed to start doing today, to become an information architect?

That is what is explained in this section. The information architects possess a higher level, broader and holistic view on the content creation process. You are no longer focused down on the neatly-greedy details of the single user guide. Instead, you look at the big picture, where and how your content is organized and how it fits the end-to-end customer experience. 

In this section, you will learn the basics of information architecture, and open the gates to the next stage in your career as a technical writer.


Section 7: Information Architecture for DITA Authors

By the end of this section you will be able to explain:

- How to govern the usage of profiling values by technical writers in the scope of a dedicated DITA map

- What is DITA subject scheme maps

In this section, I am touching upon an aspect not realized by many technical writers. Usually, that is the difference between being a technical writer and beeing an information architect in DITA. I will explain how to use DITA to control how different authors can profile content in your map, reducing profiling mistakes and ensuring a better quality of the finally produced personalized documentation.


Section 8: How to Create Interactive Images in DITA:

By the end of this section you will be able to:

- Describe the rules for using images in technical writing;

- Name the tools to use for creating graphics;

- Explain what are interactive graphics  and image maps in DITA;

- Describe the benefits of using interactive graphics;  

- Create an image map for an image in your documentation;


Section 9: Linking Strategies

By the end of this section you will be able to:

- Manually create a link to a topic or a web page from DITA source;

- Activate automatic link generation, using the collection-type attribute in DITA maps.


Here comes another great benefit of DITA - the possibility to automatically generate links to the underlying content, instead of wasting time creating (and correcting!) links one after the other. Once you put your content in the DITA map, you activate the automatic generation of links - and that's it - the links are there.

No more hassle around finding one topic and linking to it, and fixing the broken link - it all happens in a matter of minutes in the map set up.


Section 10: Final Assignment

To demonstrate that you have learned to write software documentation using DITA XML and to proudly present it as a part of your CV

you need to deliver a final assignment.

You will use it to showcase your knowledge and abilities.


To make it even more valuable for you, upon completion of the assignment, you shall receive personalized feedback and critique from the course trainer!


Why DITA?


Structured writing in DITA XML is an advanced discipline for technical writers. You can find many authors with decent language and writing skills. But you already know that technical writing is so much more than just written text with no spelling mistakes, isn't it?


If you need your technical writers to:

- Strictly follow your company or industry writing guidelines;

- Be able to spend less time on the maintenance of old documentation and spend more time on value-added activities for the customer;

- Offer information that can be reused on all levels - entire guides, chapters, topics, sentences or even single words;

- Maintain a very high content quality standard  with no broken links and missing content;

- Produce as many different output formats as your customer needs - all from the same content

- Use metadata to classify the content that was written and offer it for automated forms of information consumption;

then most probably you are already evaluating DITA as an option for writing. 

DITA already offers all listed functionality and even more!


Being a technical writer who knows how to use DITA can open the doors for you to start a career in some of the greatest IT companies in the world!


Companies Using DITA

Here are just a couple of company names that write their documentation using DITA XML:

- Apple

- IBM (they invented DITA, after all!)

- Google

- VMware

- SAP SE

and hundreds of other companies, many of which in the IT and software development industry!


What students are saying?


"I value the comprehensive training, challenging practice assignments, and a variety of techniques used to improve and inform my writing!"

- Devon Apple, Web Developer


"If you want to know how to write using DITA go and check this course! The lecturer provides great explanations and tutorials, which are really helpful in practice."

- Karina Delcheva, Technical Writer


"Very good and comprehensible introduction to the world of DITA and XML Author software. I would highly recommend this course for everyone who wishes to quickly understand the subject and start using it..."

- Boris, a University student


If you are looking for a way to advance in your career as a DITA technical writer, this in your course! I am sure that you've already seen just by searching Google, that a course like this costs way above 1000$ and takes at least a week of physical and/or online presence, travel expenses, and... usually does not even cover half of the material I present here! Thanks to Udemy's policy for delivering the best courses to as many people as possible, we've managed to reduce the cost to only 199$, only here on Udemy!

The course still comes with an interactive and community part - you will get access to a closed learning community on our JPDocu Learning Facebook page.

You will have the chance to get in contact directly with the trainer of this course and receive personalized feedback on questions you may have on using DITA.

You will get an invaluable certificate upon the successful completion of this course, that you can put on your CV, or share on Facebook and LinkedIn - do not underestimate the importance of this certificate - without it, you most probably will never make it on the shortlist for the job interview of your dream job!

And maybe the most important part, that will allow you not only to get to but also to brake though a job interview - your own work that you can use to demonstrate what you have learned an how you applied DITA to produce documentation!


Enroll now and see how simple and beneficial technical writing with DITA XML can be!


P.S. If you are looking for a job as a technical writer in a software development company - check 2 things:

1. Are they writing software documentation using DITA XML?

2. Which tool are they using for writing?


Be prepared even before your job interview to showcase the DITA XML documentation you have written using Oxygen XML Author and prove how good you are in applying reuse strategies and advanced DITA techniques - profiling, automated linking and image maps.


P.S.S. Do not forget that the course comes with a 30-day full refund policy - no questions asked!

Who this course is for:
  • Technical writers who want to advance their knowledge in DITA