Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleDescription

The short description is a short paragraph of one to three sentences. It describes the content of the document . This information is typically displayed in document lists, where the name is rendered side by side with the short description ( and maybe other properties, depending on the context). The short description is a tool for the Reader readers to determine, if she is they are interested to open read the document or skip it.

Typically short descriptions are displayed on top of a document and in document lists. The short description is rendered together with the name and maybe more metadata from the document's properties. This supports readers with navigating the documentation.

References Box

For information on how to write expressive short descriptions, please have a look at Writing Short Descriptions.

...