Writing guideTopic types

Topic types

Grafana Labs documentation is made up of different topic types: concept, task, reference, and tutorial. We encourage you to use these topic types when you write content.

Depending on the needs of a particular product area, select a topic type from the following table to learn about each.

TypeDescription
ConceptProvides an overview and background information. Answers the question “What is it?”.
TaskProvides numbered steps that describe how to achieve an outcome. Answers the question “How do I?”.
ReferenceProvides users with the information they might need to refer to during a task. Answers the question “What details do I need to accomplish this task?”.
TutorialProvides procedures that users can safely reproduce and learn from. Answers the question: “Can you teach me to …?”

For your convenience, we have created topic templates.