Art of the short description

The short description is an optional element in DITA, but it has powerful usability implications. Carefully-written short descriptions can help readers more successfully navigate information and locate topics that answer their questions. In addition, the act of crafting careful short descriptions can help writers clarify their understanding of the technical content. This session will cover how the content of the <shortdesc> element is displayed in various forms of output, such as PDF, Eclipse-based help, and Microsoft HTML Help. It then will focus on best practices for writing short descriptions that are concise, meaningful, and useful for readers.

Session presented by Kristen James Eberlein at DITA Europe 2007.

art_of_the_short_description.pdf329.64 KB Focus Areas: BPEL | DITA | ebXML | IDtrust | OpenDocument | SAML | UBL | UDDI
OASIS sites: OASIS | Cover Pages | | AMQP | CGM Open | eGov | Emergency | IDtrust | LegalXML | Open CSA | OSLC | WS-I