Are there core DITA topic types that every documentation project should use?
Within DITA, there are core topic types that provide a foundation for organizing and presenting content in documentation projects. While not every documentation project is required to use all of these core topic types, they serve as a basis for creating comprehensive and well-structured documentation.
The core DITA topic types are tasks, concepts, references, and glossaries.
Task Topic
Task topics are used to provide step-by-step instructions for completing a specific action or task. They typically include elements like titles, steps, prerequisites, and post-requisites. Task topics are crucial for guiding users through procedures.
<task>
<title>Installing Software</title>
<taskbody>
<steps>
<step>Download the software installer.</step>
<step>Run the installer and follow on-screen instructions.</step>
<step>Complete the installation process.</step>
</steps>
</taskbody>
</task>
Concept Topic
Concept topics explain underlying principles, theories, or concepts relevant to the subject matter. They help users understand the “why” and “what” behind certain processes or features.
<concept>
<title>Data Encryption</title>
<conbody>
<p>Data encryption is a process of converting plain text into ciphertext to secure sensitive information.</p>
<p>It helps protect data from unauthorized access and ensures confidentiality.</p>
</conbody>
</concept>
Reference Topic
Reference topics provide detailed information about specific elements, features, or settings. They serve as a comprehensive reference guide for users who need in-depth information.
<reference>
<title>Software Settings</title>
<refbody>
<section>
<title>General Settings</title>
<p>General settings allow you to configure basic preferences for the software.</p>
<!-- Additional details and subsections -->
</section>
<!-- More sections and details -->
</refbody>
</reference>
Glossary Topic
Glossary topics define terms, acronyms, or jargon used in the documentation. They provide clear and concise explanations to ensure users understand specialized terminology.
<glossary>
<title>Glossary of Terms</title>
<glossentry>
<glossterm>API</glossterm>
<glossdef>An Application Programming Interface (API) is a set of rules and protocols for building and interacting with software applications.</glossdef>
</glossentry>
<!-- More glossary entries -->
</glossary>