Documentation Standards¶

Guidelines for writing clear, helpful documentation.

Principles¶

• Clear - Easy to understand
• Concise - No unnecessary words
• Complete - All necessary information
• Current - Keep up-to-date with code

Structure¶

• Start with overview
• Include code examples
• Link to related pages
• Add diagrams where helpful