Style Guide
A comprehensive guide for maintaining consistent documentation style.
Writing Style
- Use clear, concise language
- Write in present tense
- Use active voice
- Keep sentences short and direct
- Maintain professional tone
Formatting Standards
- Use proper heading hierarchy (H1 → H2 → H3)
- Include code blocks with proper syntax highlighting
- Use lists for sequential steps
- Add descriptive alt text for images
- Maintain consistent spacing
Code Examples
- Include practical, working examples
- Use proper syntax highlighting
- Add comments to explain complex logic
- Show both basic and advanced usage
- Include error handling examples
Documentation Structure
- Start with a clear introduction
- Include a table of contents for longer documents
- Group related information
- End with relevant links or next steps
- Add version information when necessary