By name: doc-style description: Guidelines for technical writing in this project. Style, tone, formatting, and patterns for text in Markdown files and notebooks. Use for documentation, reports, and papers.
Use sentence case for headings and descriptive lists.
- # Experiment Design
-
- - **Foo Bar:** baz
+ # Experiment design
+
+ - Foo bar: baz
But use lists sparingly.
Technical precision with accessibility. Explain complex concepts clearly, with minimal jargon, but without oversimplifying. Bridge technical depth with broader implications for thoughtful readers.
Structured analytical thinking. Organize ideas hierarchically and build arguments systematically with clear delineation of concepts. Prefer paragraphs for nuanced or complex explanations, but use lists for summarizing steps, or when clarity would benefit from structure.
Confident intellectual honesty. Express uncertainty while maintaining substantive positions.
Direct, conversational tone. Use a friendly, approachable style. Avoid overly formal language. Especially avoid sales pitch grandeur. Maintain a tone that is approachable and professional — informal enough to invite engagement, but clear and technically precise.
Spend a lot of time iterating on prose to compress the information. Text exists to communicate; if it's long or convoluted, it will fail. We take great pride in doing the hard work of distilling complex ideas into clear, concise text, so our readers can absorb it easily.