# Codelab Writing Guide

## Plan and design
- **Outline**: Plan content before you write.
- **Audience**: Assess reader knowledge levels.
- **Progression**: Increase complexity in steps.

## Writing Style
- **Tone**: Write in an informal, conversational voice.
- **Clarity**: Avoid or explain all jargon terms.
- **Visuals**: Support text with images and diagrams.

## Markdown Style
- **Code**: Format inline code with single backticks and blocks with triple backticks.
- **Links**: Prevent broken links by using explicit header IDs.
- **Paths**: Write file paths in monospace format.

## Visual Style
- **GUI Elements**: Apply bold styles to menu names and labels.
- **Images**: Put files in the `images/` folder and link to them using relative paths.
- **Zippies**: Limit expandable sections to optional hints or answers.

## Documenting Code
- **Inline code**: Format with single backticks.
- **Code blocks**: Use fenced blocks with language tags.
- **Placeholders**: Use italic formatting for variables in examples.

## See Also
- [Style Guide](style_guide/style.md)
- [Text Formatting](style_guide/text-formatting.md)