Good Docs Project Templates

Articles

How-To Guide Template
Overview This guide explains how to {insert a brief description of the task}. {Optional: Specify when and why your user might want to perform the task.} Before you start {This section is optional} Before you {insert a brief descrip...
Reference Template
{Reference description} {This section provides a structured list of settings, field descriptions, and other reference details. This document can serve as a standalone reference or complement other types of documentation, typically at the end o...
Tutorial Template
Overview In this tutorial, you’ll learn how to {insert brief description of the main tutorial task}. This tutorial is intended for {audience}. It assumes you have basic knowledge of: Concept 1 Concept 2 Concept 3… By the end of this tu...
Explanation Template
A summary paragraph introducing a concept, explaining its importance or relevance, and providing an overview of the content that will be covered in the document (scope). Typical wording to use is: This article explains the basics of {concept...