DITA: Shortdesc (short description)
shortdesc element allows you to add a summary overview of the topic in a couple of sentences right below the topic title and before the conbody or taskbody element.shortdesc element is more important than it initially appears to be.
Although optional, it's highly recommended that you use this tag. The
shortdesc appears in several key places:
- As a tooltip in links pointing to the page
- As a description on a parent page containing child pages
- As the summary that appears in search results
- Possibly as context sensitive help (perhaps pulled as a tooltip to show in an interface with a link to learn more)
Here's an
example:
<concept id="concept">
<title>Wheel truing overview</title>
<shortdesc>Truing your wheels requires you to tighten or loosen spokes with a spoke wrentch in a balanced pattern in order to change the shape of the wheel.</shortdesc>
<conbody>
<p>Blah blah blah...</p>
</conbody>
</concept>
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.