projectdoc Toolbox

Describes the content and the intention of the document instance. This is a longer form of the short description document property.

The description section of a document informs about its content and intention. This is a descriptive abstract, similar to a table of contents, and a longer form of the Short Description document property.

The description helps potential readers to decide, whether or not relevant information can be found in the document.

 

Some document types may interpret this property different. A Glossary Item for instance, puts the definition of the term in the description section. A Role describes the role instead of describing what the intention of a particular role document instance is.

Since the location of this section typically makes the intention of the text obvious, the section title may be hidden. For more information please refer to No need to render the Section Title in Tips.

Resources

  • Summary - An informative summary about the content of the document instance. This section is not meaningful to every document type.
  • Short Description - The short description 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.