The Good Docs Project Template Guides

The Good Docs Project Templates

Guides to all Templates (main) developed by The Good Docs Project.

Core Pack

The core documentation pack is our flagship template pack and it includes the core, fundamental content types that every documentation project needs. If you download one template pack for your project, it should be this one.

See all Core pack templates...

Concept

An explanation of a concept, context, or background information about a product or its features.

core

How-to

A how-to is a concise set of numbered steps to do one task with the product.

core

README

REAMDE files include information users need to know about your project, including how users can engage with the project and get started with the tool.

core community

Reference

A reference document provides specific, in-depth details about a particular topic.

core

Release notes

Release notes communicate new features, improvements, bug fixes, and known issues about a product to users and stakeholders.

core

Troubleshooting

A list of common problems (referred to as symptoms) experienced by users, an explanation of the causes, and steps to resolve the issue.

core

Tutorial

Instructions for setting up an example project using the product, intended for the purpose of hands-on learning.

core

Community Pack

The open source community docs template pack includes the fundamental content types that every open source project needs to have a healthy and productive community.

See all Community pack templates...

Bug report

The bug report is an issue template that your users can fill out to provide you with higher-quality, actionable bug issues for your product.

community

Code of Conduct

A Code of Conduct helps you govern your open source or developer community to ensure it remains healthy and open.

community

Code of Conduct incident record

Used as part of the Code of Conduct process, an incident record is a form that is filled out when a community moderator takes an incident report from a community member.

community

Code of Conduct remediation record

Used as part of the Code of Conduct process, a remediation record is a form that is filled out when a community moderator meets with a community member to explain the consequences of a Code of Conduct violation.

community

Code of Conduct response plan

Used as part of the Code of Conduct process, the response plan explains the policy your team will follow as you handle Code of Conduct incidents.

community

Contributing guide

A CONTRIBUTING document tells users how they can contribute to your open source project and join the community.

community

Our team

Our team documents help you clearly communicate who belongs to your open source project or organization and how contributors can contact or work with them.

community

README

REAMDE files include information users need to know about your project, including how users can engage with the project and get started with the tool.

core community

All Templates

Below you will find all templates in alphabetical order.

API quickstart

API quickstarts describe the easiest way for readers to achieve a result that shows off the capabilities of your service.

misc

API reference

API references are technical manuals that provide API specifications and integration instructions to help your audience understand the service.

misc

Bug report

The bug report is an issue template that your users can fill out to provide you with higher-quality, actionable bug issues for your product.

community

Code of Conduct

A Code of Conduct helps you govern your open source or developer community to ensure it remains healthy and open.

community

Code of Conduct incident record

Used as part of the Code of Conduct process, an incident record is a form that is filled out when a community moderator takes an incident report from a community member.

community

Code of Conduct remediation record

community

Code of Conduct response plan

Used as part of the Code of Conduct process, the response plan explains the policy your team will follow as you handle Code of Conduct incidents.

community

Concept

An explanation of a concept, context, or background information about a product or its features.

core

Contact support

A contact support page typically includes a list of the communication channels, discussion forums, and links to other resources to assist users with issues that they are having with your product.

misc

Contributing guide

A CONTRIBUTING document tells users how they can contribute to your open source project and join the community.

community

Glossary

A reference document that lists and organizes terms and their definitions that are unique to your organization or which you use in a specific way.

misc

How-to

A how-to is a concise set of numbered steps to do one task with the product.

core

Installation guide

An installation guide explains all the necessary steps to install the product and set it up for further use.

misc

Our team

Our team documents help you clearly communicate who belongs to your open source project or organization and how contributors can contact or work with them.

community

Quickstart

A quickstart introduces your users to your application for the first time. It focuses on the primary feature of the application and helps your users to start using the application as quickly as possible.

misc

README

REAMDE files include information users need to know about your project, including how users can engage with the project and get started with the tool.

core community

Reference

A reference document provides specific, in-depth details about a particular topic.

core

Release notes

Release notes communicate new features, improvements, bug fixes, and known issues about a product to users and stakeholders.

core

Style guide

A style guide provides project contributors with general guidelines for writing project documentation.

misc

Terminology system

Using this template, writing teams can ensure they consistently use and translate the same terms across all the documentation in their system.

misc

Troubleshooting

A list of common problems (referred to as symptoms) experienced by users, an explanation of the causes, and steps to resolve the issue.

core

Tutorial

Instructions for setting up an example project using the product, intended for the purpose of hands-on learning.

core

User personas

User personas are a framework to identify the characteristics that differentiate each user type for your product or service. Discovering more about your users will help you make user-centric product decisions and produce better documentation.

misc