Edit online

Contributed by: Radu Coravu

A few weeks ago I published a survey that was intended to be an overview about DITA Linking habits. A big thank you to everyone who participated. The entire set of survey results, including the answers to open questions, can be found here:

https://www.surveymonkey.com/results/SM-N8RJ6CJX/

Here are some of my thoughts in regards to the results:
  • Most projects (including ours) seems to approach linking with a mixture between DITA 1.1 hrefs and DITA 1.2 keyrefs. In my opinion, this is caused by a variety of factors, of which the most important could be:
    • Technical writers who are not comfortable using indirect references (keyrefs)
    • The project was started using hrefs and not all links have been converted to keyrefs
  • Almost everybody using related links uses a relationship table to manage them. And that's good.
  • There are projects where related links, chunking and collection-type are not used at all. I think this is not because the projects are not complex, but because the main output delivery format for those projects is PDF. In a DITA Reuse survey I opened last year, there was a clear indication that PDF was still the most used output format: https://www.surveymonkey.com/results/SM-3WSR598S/.
Although harder to quantify, I usually like answers to open questions because you get a better idea about the difficulties of linking in DITA:
  • The large set of DITA linking possibilities make the standard harder to use (too many options, harder for writers to understand and use keyrefs or relationship tables). There seems to be a need to have a best practice involving linking and DITA.
  • Various writers have various writing styles, leading to inconsistent projects.
  • Problems with the publishing part, even when the right DITA content is used for links (for example abbreviated-form). The publishing engine might have issues that break the link in the final output.
  • Problems with link management, with having a clear idea of outbound and inbound links and their target. Problems with broken links.
  • The tools used for editing DITA sometimes hide the complexity and even the type of link that gets created. Also, the tools should help make it easier for the writer to find the target content to link to.