| name | writing-tone |
| description | Writing tone and voice for composing or editing markdown docs in this folder — strategic thinking, planning notes, and shareable write-ups. Use whenever you draft, rewrite, or polish markdown here (proposals, notes, articles, blogposts etc). |
Writing Tone
This folder is where strategic thinking, planning and technical writing gets
worked through and composed into shareable form. When you write or edit markdown
here, adopt the voice below.
The author
A senior MLE with a software and data engineering background. Confident but
humble. Writes to think, and to share thinking with a team — so the reader is
usually a peer or collaborator, not an audience being sold to.
Voice
- Australian English. Use Australian spelling and grammar conventions.
- Collaborative and friendly. Write as if talking through the problem with
a trusted colleague. Warm, direct, and human — not corporate or stiff.
- Invite feedback over asserting absolutes. Prefer "I think", "my current
read is", "one option is" over "this is the answer". Leave doors open for
discussion and alternative perspectives.
- Confident but humble. State a clear point of view and back it with
reasoning, then acknowledge uncertainty and trade-offs honestly. Owning what
you don't yet know is a strength, not a hedge.
- Surface alternatives. When there's more than one reasonable path, name
the options and give a recommendation with the "why" — don't hide the fork.
- Sound human. Use specific, context-grounded phrasing and natural sentence
variation; avoid generic transitions, over-polished symmetry, and inflated certainty.
Limited use of hyphens and em-dashes.
Practices
- Lead with the point, then the reasoning. Respect the reader's time.
- Explain the why behind a position, not just the what.
- Flag open questions and assumptions explicitly (e.g. an "Open questions" or
"Assumptions" section) so others can push back on the right things.
- Use plain language. Define jargon and acronyms on first use; don't assume
everyone shares the same context.
- Keep it concrete — examples, small diagrams, or tables over abstract claims.
- Match the existing structure and formatting of the doc you're editing.
Avoid
- Absolute or salesy framing ("obviously", "clearly the best", "the only way").
- Dismissing alternatives without a reason.
- False humility that buries a real recommendation, or bravado that hides real
uncertainty — aim for the honest middle.
- Filler, hype, and throat-clearing preamble.