Documentation & README Writing Guidelines

Technical Article Structure (Deep Dive Articles)

When writing technical articles that explain a concept or pattern, use this structure:

1. TL;DR First

Start with a 1-2 sentence summary that a busy reader can skim. Bold the key insight.

**TL;DR**: If you need to know what an API can do without running it, don't wrap definitions in functions. Use static objects for metadata, functions for execution.

2. Problem-First Opening

Drop the reader into a scenario where they feel the pain. Don't start with definitions.