Docs Style
by @anderskev
Core technical documentation writing principles for voice, tone, structure, and LLM-friendly patterns. Use when writing or reviewing any documentation.
clawhub install docs-styleπ About This Skill
name: docs-style description: Core technical documentation writing principles for voice, tone, structure, and LLM-friendly patterns. Use when writing or reviewing any documentation. user-invocable: false
Documentation Style Guide
Apply these principles when writing or reviewing documentation to ensure clarity, consistency, and accessibility for both human readers and LLMs.
Voice and Tone
Use Second Person
Address the reader directly as "you" rather than "the user" or "developers."
You can configure the API by setting environment variables.
The user can configure the API by setting environment variables.
Developers should configure the API by setting environment variables.
Prefer Active Voice
Write sentences where the subject performs the action. Active voice is clearer and more direct.
Create a configuration file in the root directory.
The function returns an array of user objects.
A configuration file should be created in the root directory.
An array of user objects is returned by the function.
Be Concise
Cut unnecessary words. Every word should earn its place.
Run the install command.
In order to proceed, you will need to run the install command.
This endpoint returns user data.
This endpoint is used for the purpose of returning user data.
Common phrases to simplify:
| Instead of | Use | |------------|-----| | in order to | to | | for the purpose of | to, for | | in the event that | if | | at this point in time | now | | due to the fact that | because | | it is necessary to | you must | | is able to | can | | make use of | use |
Document Structure
Write Clear, Descriptive Headings
Headings should tell readers exactly what the section contains. Avoid clever or vague titles.
Install the CLI
Configure Authentication
Handle Rate Limits
Getting Started (vague)
The Fun Part (clever)
Misc (uninformative)
Create Self-Contained Pages
Assume readers may land on any page directly from search. Each page should:
Webhooks
Webhooks let you receive real-time notifications when events occur in your account.
Prerequisites
An active API key with webhook permissions
A publicly accessible HTTPS endpoint Create a Webhook
...
Use Semantic Markup
Choose the right format for the content type:
| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| api_key | string | Yes | Your API key |
| timeout | integer | No | Request timeout in seconds |
To authenticate, you can:
Use an API key in the header
Use OAuth 2.0
Use a service account
Make Content Skimmable
Break dense paragraphs into digestible chunks:
Error Handling
The API returns standard HTTP status codes.
Common Errors
400 Bad Request: Invalid parameters. Check the request body.
401 Unauthorized: Invalid or missing API key.
429 Too Many Requests: Rate limit exceeded. Wait and retry. Retry Strategy
For 429 errors, use exponential backoff starting at 1 second.
Consistency
Use One Term Per Concept
Pick a term and use it consistently. Switching terms confuses readers.
Generate an API key in the dashboard. Use your API key in the Authorization header.
Generate an API key in the dashboard. Use your API token in the Authorization header.
Document your terminology choices:
| Concept | Use | Don't use | |---------|-----|-----------| | Authentication credential | API key | API token, secret key, access key | | Configuration file | config file | settings file, preferences file | | Command line | CLI | terminal, command prompt, shell |
Apply Consistent Formatting
Use the same formatting for similar content types:
npm install)/etc/config.yaml)YOUR_API_KEY or LLM-Friendly Patterns
State Prerequisites Explicitly
List what users need before starting. This helps both humans and LLMs understand context.
## PrerequisitesBefore you begin, ensure you have:
Node.js 18 or later installed
An active account with admin permissions
Your API key (find it in Settings > API)
Define Acronyms on First Use
Spell out acronyms the first time they appear on a page.
The CLI (Command Line Interface) provides tools for managing your resources.
Subsequent uses can just say "CLI."
The CLI provides tools for managing your resources.
Provide Complete, Runnable Code Examples
Code examples should work when copied. Include:
API_KEY = "your-api-key" BASE_URL = "https://api.example.com/v1"
response = requests.get( f"{BASE_URL}/users", headers={"Authorization": f"Bearer {API_KEY}"} )
print(response.json())
Output: {"users": [{"id": 1, "name": "Alice"}, ...]}
Write Descriptive Titles and Meta Descriptions
Page titles and descriptions help with search and LLM understanding.
---
title: "Authentication - API Reference"
description: "Learn how to authenticate API requests using API keys, OAuth 2.0, or service accounts."
Pitfalls to Avoid
Don't Use Product-Centric Language
Orient documentation around user goals, not product features.
Send Emails
Send transactional emails to your users with delivery tracking.
Email Service
Our powerful email service provides enterprise-grade delivery.
Skip Obvious Instructions
Don't document self-explanatory UI actions.
Enter your webhook URL. The URL must use HTTPS and be publicly accessible.
Click in the text field. Type your webhook URL. Click the Save button.
Avoid Colloquialisms
Colloquialisms hurt clarity and localization.
This approach significantly improves performance.
This approach is a game-changer for performance.
This will blow your mind.
Let's dive in!
Quick Reference Checklist
When writing documentation, verify:
Applying This Skill
Use these principles when:
1. Writing new documentation: Apply all principles from the start 2. Reviewing documentation: Check against the quick reference checklist 3. Editing existing docs: Prioritize voice/tone, then structure, then consistency 4. Creating code examples: Ensure they are complete and runnable