Skip to content

Choose the correct content type

Carly Revier edited this page Jan 18, 2024 · 5 revisions

We recommend starting your article from one of our standard content types, available in the repo under the templates folder.

Standard content types help you to identify the correct format for the information you want to provide. When you match the intent of your audience with the requirements from your stakeholders, the right content type provides a good experience to our audience.

Below are the available content types.

Content type What is it When to use it
Overview An article explaining the service from a technical point of view.

And/or an article comparing features across related services/projects.
For new customers. To explain the service, technology, or functionality from a technical point of view. It isn't intended to define benefits or value prop; that would be in marketing content.
Quickstart Fundamental day-1 instructions for new customers to quickly try out a specific product/service.

The focus is on getting the product/service into the hands of customers so they can use it, not on documenting the procedure for setting it up.
When you can get the service, technology, or functionality into the hands of new customers in less than 10 minutes. Quickstarts are preferred, but not required if no meaningful functionality can be introduced to new users in under 10 minutes.
Tutorial Scenario-based procedures for top customer tasks.

The focus is on showing the customer how to do the task, not on helping them set up their own environment.
To show the single best procedure for completing a customer task.
Concept In-depth explanation of functionality related to a service(s) that are fundamental to understanding and use. When you want to:
- explain what something is and define its critical functions.
- describe how something works or what happens when something is done.
- provide guidelines for completing a job task in varied situations.
How-to guide Procedural articles that show the customer how to complete a task. To provide the steps for completing a task.

To help customers complete tasks in their own environment. How-to guides differ from tutorials in that they can include optional information, explanations, and information to help inform decisions.
Troubleshooting article Articles that help users solve a common issue. To help resolve a specific error or problem that customers commonly run into, and would search on.
Clone this wiki locally