Guide templates

This page provides Markdown templates for the two main document types used in Konfidence documentation. Copy the template that matches your document type and adjust it to your needs.

How-to guide

This is an MD template for your how-to guides. Copy and paste the MD code to your file and adjust it to your needs.

# [How-to guide title]

One or two sentences describing what this guide helps you do and when you'd use it.
For example, start with: This guide explains how to...

## Prerequisites

- Prerequisite 1
- Prerequisite 2

## [Describe the first required action]

1. [Describe step 1.]

2. [Describe step 2.]

    ```
    Code block for step 2
    ```

## [Describe the second required action]

1. [Describe step 1.]
2. [Describe step 2.]

## Next steps

- Link text 1
- Link text 2

Concept guide

This is an MD template for your concept guides. Copy and paste the MD code to your file and adjust it to your needs.

# [Concept guide title]

One sentence identifying the concept and signaling this is conceptual content: a technical approach or method, a software feature or functionality, or a technical or business concept.
For example, start with: This page describes...

## Overview

Describe how [concept name] works and why it exists. Include relevant background and context that helps readers build a foundational understanding before exploring its specific aspects.

## [Key aspect or component]

Explanation of one aspect of the concept.

## [Another aspect, tradeoff, or variant]

Expand as needed.

## Related information

- Link text 1
- Link text 2