cline/docs/contributing/doc-templates.mdx

---
title: "Documentation Templates"
sidebarTitle: "Templates"
description: "Templates for different types of Cline documentation"
---

Use these templates as starting points for new documentation. Each template is designed for a specific purpose. Choose the one that best fits what you're documenting.

## Choosing a Template

| If you're documenting... | Use this template |
|--------------------------|-------------------|
| What a feature does and how to use it | Feature Doc |
| How to accomplish a specific task | How-To Guide |
| Technical specifications or API details | Reference Doc |
| A complete project walkthrough | Tutorial |

## Feature Doc

Use this template when explaining a Cline feature. Focus on what it does, how to use it, and real examples.

````text
---
title: "Feature Name"
sidebarTitle: "Feature Name"
---

[One sentence explaining what this feature does.]

<Frame>
  <img src="..." alt="Feature in action" />
</Frame>

[1-2 paragraphs explaining the feature in plain terms. What problem does it 
solve? Why would someone use it?]

## How It Works

[Explain the mechanics without jargon. What happens when you use this feature?]

## Using [Feature Name]

[Show how to access and use it. Include the exact UI path.]

### [Option or Variation 1]

[Details with examples]

### [Option or Variation 2]

[Details with examples]

## Inspiration

[Share how you personally use this feature. Use "I" voice. Give 2-3 real 
examples that spark imagination about what's possible.]

<Note>
  [Important caveat, limitation, or requirement]
</Note>
````

### Example: Checkpoints Feature

Here's how the [Checkpoints](/core-workflows/checkpoints) doc follows this pattern:

- Opens with one clear sentence about what checkpoints do
- Shows a screenshot of the feature in action
- Explains how checkpoints work under the hood
- Shows exact steps to create and restore checkpoints
- Includes real examples of when checkpoints save the day

## How-To Guide

Use this template when showing how to accomplish a specific task. Focus on clear steps and troubleshooting.

````text
---
title: "How to [Accomplish Task]"
sidebarTitle: "[Short Title]"
description: "[One sentence describing what the reader will learn]"
---

[Brief intro explaining what problem this guide solves and what you'll end up 
with after following it.]

## Prerequisites

[What the reader needs before starting. Keep it short. Link to other docs 
rather than explaining setup here.]

- Cline installed and configured
- [Other requirement]

## Steps

<Steps>
  <Step title="[First Action]">
    [Clear instructions. Show exactly what to click or type.]
    
    ```bash
    example command if needed
    ```
  </Step>
  <Step title="[Second Action]">
    [Next step. Include screenshots for complex UI interactions.]
    
    <Frame>
      <img src="..." alt="What you should see" />
    </Frame>
  </Step>
  <Step title="[Final Action]">
    [Complete the task. Show the expected result.]
  </Step>
</Steps>

## Troubleshooting

Common issues and how to fix them:

- **Problem description**: Solution in one or two sentences.
- **Another problem**: Another solution.

## Next Steps

<Card title="Related Feature" icon="arrow-right" href="/path/to/related">
  Continue learning with this related guide.
</Card>
````

### Example: Your First Project

The [Your First Project](/getting-started/your-first-project) guide follows this pattern:

- Clear goal stated upfront
- Prerequisites listed briefly
- Step-by-step instructions with the Steps component
- Troubleshooting section for common issues

## Reference Doc

Use this template for technical specifications, API documentation, or detailed configuration options.

````text
---
title: "[Component/API] Reference"
sidebarTitle: "[Short Title]"
description: "[What this reference covers]"
---

[Brief description of what this reference documents and when you'd need it.]

## Overview

[High-level explanation. What is this component? What role does it play?]

## [Category 1]

### [Item Name]

[What it does in one sentence.]

| Property | Type | Default | Description |
|----------|------|---------|-------------|
| `propertyName` | `string` | `"default"` | What this property controls |
| `anotherProp` | `boolean` | `false` | What this does |

**Example:**

```typescript
// Show practical usage
const example = {
  propertyName: "custom value",
  anotherProp: true
}
```

### [Another Item]

[Continue for each item in this category.]

## [Category 2]

[Continue with other categories as needed.]

## Examples

[Show 2-3 complete, practical examples that combine multiple concepts.]

### [Example 1 Title]

```typescript
// Complete working example
```

### [Example 2 Title]

```typescript
// Another complete example
```

## Related

- [Related Doc 1](/path/to/doc) - Brief description
- [Related Doc 2](/path/to/doc) - Brief description
````

### Example: Cline Tools Guide

The [Cline Tools Guide](/tools-reference/all-cline-tools) follows this pattern:

- Overview of the tool system
- Each tool documented with parameters and examples
- Practical examples showing tools in context

## Tutorial

Use this template for comprehensive project walkthroughs where users build something from start to finish.

````text
---
title: "[Build/Create X] Tutorial"
sidebarTitle: "[Short Title]"
description: "[What the reader will build]"
---

In this tutorial, you'll build [specific outcome]. By the end, you'll have 
[tangible result you can see/use].

<Frame>
  <img src="..." alt="Preview of what you'll build" />
</Frame>

## What You'll Learn

- [Skill or concept 1]
- [Skill or concept 2]
- [Skill or concept 3]

## Prerequisites

[Required setup. Link to installation guides rather than repeating them.]

- [Prerequisite 1]
- [Prerequisite 2]

## Part 1: [First Major Section]

[Introduction to this section. What are we doing and why?]

### [Subsection]

[Detailed walkthrough with code blocks and explanations.]

```typescript
// Code that the reader should write or understand
```

[Explain what the code does and why.]

## Part 2: [Second Major Section]

[Continue building on Part 1.]

### [Subsection]

[More detailed walkthrough.]

## Part 3: [Final Section]

[Complete the project.]

## Summary

You built [what they built]. Along the way, you learned:

- [Key takeaway 1]
- [Key takeaway 2]
- [Key takeaway 3]

## Next Steps

<CardGroup cols={2}>
  <Card title="Go Deeper" icon="book" href="/path/to/advanced">
    Learn more advanced techniques.
  </Card>
  <Card title="Related Tutorial" icon="code" href="/path/to/related">
    Build something else with similar concepts.
  </Card>
</CardGroup>
````

### Example Structure

A good tutorial:
- Shows the end result upfront so readers know what they're building
- Breaks the work into logical parts
- Explains the "why" alongside the "how"
- Ends with clear next steps

## Quick Tips

When using these templates:

1. **Delete sections you don't need.** Templates are starting points, not rigid structures.

2. **Add sections that make sense.** If your doc needs something not in the template, add it.

3. **Keep the reader moving forward.** Every section should lead naturally to the next.

4. **Test your own instructions.** Follow your guide from scratch to catch missing steps.

<Tip>
  Use the `/write-docs` workflow to generate documentation from these templates automatically. 
  Cline helps you fill in each section based on your project.
</Tip>