Skip to content

SkyCMS Documentation Templates

Summary

Use these templates for new pages and major rewrites.

1) Tutorial template

## Summary
<One sentence on what the reader will achieve>

## Metadata
- Type: Tutorial
- Product area: <area>
- Audience: <audience>
- Version: <version>
- Owner: <owner>
- Last reviewed: <yyyy-mm-dd>

## Outcome
<What the reader can do after finishing>

## Prerequisites
- <item>

## Steps
1. <step>
2. <step>

## Checkpoints
- <How to confirm success>

## Next steps
- <Link>

2) How-to template

## Summary
<One sentence on the task>

## Metadata
- Type: How-to
- Product area: <area>
- Audience: <audience>
- Version: <version>
- Owner: <owner>
- Last reviewed: <yyyy-mm-dd>

## Goal
<Task objective>

## Prerequisites
- <item>

## Procedure
1. <step>
2. <step>

## Verification
- <How to verify>

## Troubleshooting
- <Issue>: <Resolution>

## Related guides
- <Link>

3) Reference template

## Summary
<One sentence on scope>

## Metadata
- Type: Reference
- Product area: <area>
- Audience: <audience>
- Version: <version>
- Owner: <owner>
- Last reviewed: <yyyy-mm-dd>

## Overview
<What this reference covers>

## Fields and options
| Name | Type | Required | Description |
| --- | --- | --- | --- |
| <name> | <type> | <yes/no> | <description> |

## Examples
```<language>
<example>
```

## Constraints
- <constraint>

## Related guides
- <Link>

4) Explanation template

## Summary
<One sentence on concept and value>

## Metadata
- Type: Explanation
- Product area: <area>
- Audience: <audience>
- Version: <version>
- Owner: <owner>
- Last reviewed: <yyyy-mm-dd>

## Context
<Problem and scope>

## How it works
<Conceptual explanation>

## Decisions and tradeoffs
- <decision>
- <tradeoff>

## Related guides
- <Link>