OpenHands/docs/DOC_STYLE_GUIDE.md

Documentation Style Guide

General Writing Principles

• Clarity & Conciseness: Always prioritize clarity and brevity. Avoid unnecessary jargon or overly complex explanations. Keep sentences short and to the point.
• Gradual Complexity: Start with the simplest, most basic setup, and then gradually introduce more advanced concepts and configurations.

Formatting Guidelines

Headers

Use Title Case for the first and second level headers.

Example:

• Basic Usage
• Advanced Configuration Options

Lists

When listing items or options, use bullet points to enhance readability.

Example:

• Option A
• Option B
• Option C

Procedures

For instructions or processes that need to be followed in a specific order, use numbered steps.

Example:

1. Step one: Do this.
2. Step two: Complete this action.
3. Step three: Verify the result.

Code Blocks

• Use code blocks for multi-line inputs, outputs, commands and code samples.

Example:

docker run -it \
    -e THIS=this \
    -e THAT=that
    ...