Home
Language and punctuation
Avoiding writing for output
Do not include formatting information in your DITA content topics.

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
Language and punctuation
- Avoiding writing for output
  Do not include formatting information in your DITA content topics.
- Stem sentences, glue text, and other transitional information
  Transitional information, such as stem sentences, is largely redundant in DITA's minimalist, topic-based, semantic mark-up architecture. The role of transitional information in contextualising the content has been eliminated through the use of smaller chunk sizes, meaningful titles, information typing, structure, and demarcation labels automatically-generated in the output.
- Punctuation in lists
  Ordered and unordered list items should have no terminating punctuation marks, such as commas, semicolons, and full stops, except when all items in a list are complete sentences. This approach maximises re-usability.
- Titles and headings
  Titles are used in a number of mark-up structures in DITA. Titles are a mix of content and metadata. The mark-up in titles should be kept as simple as possible, and workarounds to achieve specific formatting outcomes should not be used.
- Crafting paragraphs
  A paragraph should contain one unit of thought or action, or main point, and should be typically three to eight sentences in length. All of the sentences in a paragraph should relate to its main point.
- Different languages
  The xml:lang attribute stores the human language of the content, and can be applied to any DITA element.
- Quotation marks
  Quotation marks should not be included in DITA content. The marks should be added, if required, during the publishing process.
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.

Avoiding writing for output

Do not include formatting information in your DITA content topics.

If you find that you are deliberately coding your DITA topics in such a way as to achieve a particular output effect, you are without doubt taking the wrong path. DITA topics must be delivery-agnostic; they must be free of as much context (how the information is going to be used, presented or sequenced) as possible.