Skip to content

docs: add the house writing style (docs/WRITING.md) #120

Closed

Description

@amar-python

Decided by the product owner on 27 Oct 2026: a technical-writing house style applies to all writing in this repo, and a short version is committed as docs/WRITING.md.

The decisions it records:

  • Scope: all repo writing, by anyone.
  • Spelling: Australian in prose. Code identifiers keep their own spelling.
  • Footers: no "Generated with …" footer on issues or PRs.
  • Address: "the product owner" in issues, PRs and repo docs.

Done when

docs/WRITING.md is merged to main and this issue links the merge commit.


Generated by Claude Code

Activity

  1. added 2 commits that reference this issue on Oct 27, 2026
  2. amar-python commented on Oct 27, 2026

    @amar-python
    OwnerAuthor

    Merged by the product owner's instruction on 27 Oct 2026, once all checks passed.

    docs/WRITING.md is now on main.


    Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions