Docs Write

Write documentation following CLEO style guidelines

Docs Write

The Docs Write skill provides context injection for writing documentation that follows the CLEO documentation style guide.

Overview

Property	Value
Skill ID	ct-docs-write
Tier	3 (Support)
Protocol	implementation
Tags	documentation, writing

Style Guidelines

Voice and Tone

• Direct: State things clearly without hedging
• Conversational: Write as you would speak to a colleague
• Technical: Be precise about technical details
• Helpful: Focus on solving the reader’s problem

Word Choices

Avoid	Use Instead
utilize	use
leverage	use
offerings	services, products
easy, simple	(remove - let reader judge)
users	people, developers, companies
click here	descriptive link text

Structure

1. Lead with the important information
2. Use headings that state the point
3. Keep paragraphs short (3-4 sentences max)
4. Use lists for multiple items
5. Include code examples that actually work

Formatting

• Use sentence case for headings
• One blank line between sections
• Indent code blocks with appropriate language tag
• Use tables for structured comparisons

Document Types

Conceptual Documentation

Explains what something is and why it exists:

# Feature Name

Brief overview of what this feature does and why it matters.

## Key Concepts

### Concept 1

Explanation with minimal jargon.

### Concept 2

Explanation with relevant example.

Procedural Documentation

Step-by-step instructions:

# How to Do Something

Brief context for when to use this procedure.

## Prerequisites

- Requirement 1
- Requirement 2

## Steps

1. First step with explanation
2. Second step
3. Third step

## Verification

How to confirm it worked.

Reference Documentation

API and configuration details:

# Command Reference

## command-name

Brief description.

### Syntax

\`\`\`bash
command [options] <required> [optional]
\`\`\`

### Options

| Option | Description | Default |
|--------|-------------|---------|
| `--flag` | What it does | value |

### Examples

\`\`\`bash
# Example with explanation
command --flag value
\`\`\`

Integration with Documentor

This skill is invoked by ct-documentor during the write phase to:

• Create new documentation following style guidelines
• Update existing documentation maintaining consistency
• Apply proper formatting and structure

Quality Checklist

Before completing:

• Follows CLEO style guide
• No formal/corporate language
• Headings state the point
• Code examples tested
• Links are descriptive
• Important info leads

Related Skills

• Documentor - Orchestrates documentation
• Docs Lookup - Finds existing documentation
• Docs Review - Reviews documentation quality