Abstract and Short Description Elements
A short description element provides a short summary about a topic. An abstract element extends the short description.
Consistent use of short descriptions and abstracts enables you to quickly navigate topics.
DITA Guidelines
- Do not make short descriptions longer than two sentences
- If you need a more robust introduction to a topic that does not fit into the short description element, combine an abstract element with a short description element
- An abstract element can contain block elements that are unavailable in short description elements
Style Guidelines
- Do not begin short descriptions with “Learn how...”, “This topic...”, etc.
- Do not restate the title
- Be descriptive
Short Description Example
The Gray and Color templates are complete and modular styles that you can leverage to quickly create your own Heretto PDF Generator templates.