Announcing Templates release 1.1 (Dragon)
The Dragon release introduced the overhaul of our Concept template and two new templates.
The Good Docs Project just published our latest release of documentation templates! This version 1.1 is codenamed Dragon. Our releases are codenamed after bridges because we’re “bridging the documentation gap for our users.” The Dragon release is named for the Dragon Bridge over the river Han in Vietnam.
The highlight of the release for us is the overhaul of the Concept template, which is part of our Core documentation pack. Concepts are a fundamental building block of all documentation projects and this template represents more than a year of work by several templateers from the EMEA and APAC regions of our project.
The Dragon release features two brand new templates:
-
Terminology system - A terminology system is a collection of agreed-upon terms that form a common language within a particular domain.
-
Troubleshooting - A troubleshooting guide lists solutions to common problems to help users or developers resolve them quickly. Note that this template is part of the Core documentation template pack.
The Dragon release also includes a minor template rework of the Installation guide template to add some additional missing files that we now require as part of all our templates: the process file (which explains how to write that type of content), and the resources file (which cites examples and other sources the templateers used to create the template).
A huge thank-you to all our template contributors! You can read more about the contents of this release and the contributors involved in our release notes in GitLab.
Text of article ©2024 Alyssa Rock
Released under Creative Commons Attribution 4.0 International (CC BY 4.0)