Marin House Style
Read the medium-specific guide for the deliverable, then apply
ai-writing-donts.md as the final prose pass.
Read The Right File
- Read blog-posts.md for public explainers and blog posts.
- Read reports.md for technical reports aimed at peer researchers outside Marin.
- Read tutorials.md for learning-oriented documentation that introduces Marin.
- Read reference-docs.md for precise usage docs aimed at readers who already know Marin.
- Read issues.md for standard OSS issues and experiment issues.
- Read pull-requests.md for commit messages and PR titles and bodies.
- Read discord.md for Discord summaries and tactical replies.
- If a piece spans media, use the stricter applicable rule.
Voice
Write as a rigorous open-science lab building foundation models. Treat
experiments, decisions, and mistakes as part of the record. Use a sober,
practical voice for technically capable peers. Be natural and direct; use
specialized language when it improves precision.
On Voice
These rules are stricter for agents. Preserve harmless human flourishes when
editing another person's prose.
Evidence and scope
- Lead with the result, decision, or changed behavior.
- Support claims with numbers, examples, observations, and relevant artifacts.
- State uncertainty and limitations plainly; do not imply broader evidence.
- Remove hype, product-announcement language, AGI speculation, decorative
emoji, and adjectives standing in for evidence.
- Explain non-standard terms. Add detail only when it helps the reader
reproduce, evaluate, or act.
Add Structure For Longer-Form Writing
Long-form pieces may need a document-level TL;DR and section takeaways. Do not
force them into short media.
Before publishing, confirm the prose is factually current, sounds normal when
spoken to a colleague, cites material evidence, and contains no generic filler.
1---2name: writing-style3description: Apply Marin house style when producing or revising commit, pull-request, issue, comment, documentation, report, or blog prose.4---56# Marin House Style78Read the medium-specific guide for the deliverable, then apply9[ai-writing-donts.md](ai-writing-donts.md) as the final prose pass.1011## Read The Right File1213- Read [blog-posts.md](blog-posts.md) for public explainers and blog posts.14- Read [reports.md](reports.md) for technical reports aimed at peer researchers outside Marin.15- Read [tutorials.md](tutorials.md) for learning-oriented documentation that introduces Marin.16- Read [reference-docs.md](reference-docs.md) for precise usage docs aimed at readers who already know Marin.17- Read [issues.md](issues.md) for standard OSS issues and experiment issues.18- Read [pull-requests.md](pull-requests.md) for commit messages and PR titles and bodies.19- Read [discord.md](discord.md) for Discord summaries and tactical replies.20- If a piece spans media, use the stricter applicable rule.2122## Voice2324Write as a rigorous open-science lab building foundation models. Treat25experiments, decisions, and mistakes as part of the record. Use a sober,26practical voice for technically capable peers. Be natural and direct; use27specialized language when it improves precision.2829## On Voice3031These rules are stricter for agents. Preserve harmless human flourishes when32editing another person's prose.3334## Evidence and scope3536- Lead with the result, decision, or changed behavior.37- Support claims with numbers, examples, observations, and relevant artifacts.38- State uncertainty and limitations plainly; do not imply broader evidence.39- Remove hype, product-announcement language, AGI speculation, decorative40 emoji, and adjectives standing in for evidence.41- Explain non-standard terms. Add detail only when it helps the reader42 reproduce, evaluate, or act.4344## Add Structure For Longer-Form Writing4546Long-form pieces may need a document-level TL;DR and section takeaways. Do not47force them into short media.4849Before publishing, confirm the prose is factually current, sounds normal when50spoken to a colleague, cites material evidence, and contains no generic filler.
marin-community