Home
Syntax and mark-up
Short descriptions
The short description (or shortdesc) is arguably the most important component of a DITA topic, and is also one of the most difficult elements to write. Short descriptions should be written for every topic.
Guidelines for crafting short descriptions
Short descriptions are difficult and time consuming to write. Following guidelines for shortdesc creation will make the task easier, and result in more consistent descriptions.

Introduction
Information types and topics
Topics are the building blocks of modular documents, and organising topics by semantic information types is one of the architectural features of DITA.
DITA map files
Syntax and mark-up
- Organisation of DITA elements
  Elements in DITA are grouped together into a number of categories for organisational and comprehension purposes.
- Working with mark-up
- Element domains
  Elements in DITA are arranged into domains for organisational purposes and technical reasons.
- Short descriptions
  The short description (or shortdesc) is arguably the most important component of a DITA topic, and is also one of the most difficult elements to write. Short descriptions should be written for every topic.
  - Purpose of short descriptions
    Short descriptions typically perform three different functions: providing an overview in the first paragraph of the topic, as link preview text (or hover text) in hypertext outputs, and as part of the subordinate topic preview text in the parent of the topic.
  - Guidelines for crafting short descriptions
    Short descriptions are difficult and time consuming to write. Following guidelines for shortdesc creation will make the task easier, and result in more consistent descriptions.
  - Abstracts
    Abstracts can contain multiple shortdesc elements, which are typically processed slightly differently to standalone shortdesc elements.
  - Cross-references and typography in shortdesc elements
    Although it is possible to embed a phrase (ph) element in a shortdesc, and then include formatting and xref elements within the phrase, it is not a semantically sound practice.
  - Making shortdesc elements compulsory
    It is possible for publishing teams to make the use of short descriptions mandatory through specialisation and constraints mechanisms within DITA.
  - Short descriptions in the ditamap
    Short descriptions specified in a DITA topic can be overridden by alternative short description elements in the ditamap.
- Lists
  The purpose of a list is to make it easier for the reader to understand sequences of information and collections of like information. Different types of lists are used for different information structures.
- Paragraphs
  Paragraphs are the basic components of topics. A paragraph (p) element should be a self-contained unit dealing with one idea or point, typically expressed in two or more related sentences. The p element should be used when no other semantically-specific block element is available.
- Procedures and steps
  The purpose of procedural documents is to explain to the reader how to accomplish tasks. The task information type is specifically designed for procedures, with a well-defined structure built around steps.
- Tables
  The purpose of a table is to structure, organise and present factual data that a user will need to look up or reference. There are two general purpose table types in DITA: table and simpletable.
- Phrases
  The semantics of words and phrases in DITA content is expressed through a broad range of phrase elements.
- Special characters and dates
Language and punctuation
Graphics and figures
Cross-referencing
Cross-references are a means of binding individual topics into a coherent and navigable document.
Content re-use
Metadata, conditional processing, and indexing
The DITA documentation process
DITA authoring concepts
Moving from style-based authoring to a structured authoring methodology such as DITA requires a radically different approach to writing.

Guidelines for crafting short descriptions

Short descriptions are difficult and time consuming to write. Following guidelines for shortdesc creation will make the task easier, and result in more consistent descriptions.

This table is a summary of the recommendations made by Kris Eberlein in her Art of the Short Description presentation at the 2007 DITA Europe Conference.

Do:	Don't
Make the shortdesc standalone, so that the topic is not dependent upon the shortdesc. Make the shortdesc concise and complete. Include less than 50 words in only one or two sentences. Use complete sentences, except for short topics such as in API documentation.	Restate the title. State the obvious. Start the shortdesc with this topic.... Use the shortdesc as a lead-in sentence.

Different approaches to writing short descriptions are required for different information types.

Information Type	Guidelines
Task	The shortdesc should answer the questions of what are the benefits of the task, and what is the purpose of the task. Include information about when the user should perform the task (or why the task is necessary). If applicable, include information about who performs the task.
Concept	The shortdesc should answer the questions of what is this, and why do I care about this. Start with a brief definition, if the concept is unfamiliar. Make sure the shortdesc contains the main point of the topic.
Reference	The shortdesc should answer the questions of what are the items, what do they do, and what are they used for. Use consistent phrasing across document sets so that your information can be easily integrated into a range of publications.