Publishing Doctrine

Published · Updated

Article content

This site publishes two kinds of operational writing:

Changelog = what shipped

Use changelog entries to record concrete production changes.

Required for every meaningful PR.

Keep entries factual and concise:

  • Added / Changed / Fixed
  • Impact statement
  • Links to PR/commit when useful

If someone asks “what changed?”, the changelog should answer it fast.

Field notes = what we learned

Use field notes to capture process insight from real work.

Publish a field note every 2–4 PRs, or any time there’s a notable debugging session or decision.

Good field notes include:

  • context and goal
  • friction/surprises
  • tradeoffs and rationale
  • what we’d do differently
  • next experiment

If someone asks “why did you do it this way?”, field notes should answer that.

Cadence

  • Every meaningful PR → changelog entry
  • Every 2–4 PRs (or notable incident) → field note
  • /pages/now reviewed every merged PR batch; update when weekly priorities change
  • Weekly hard refresh of /pages/now (rewrite focus, not just typo edits)
  • Monthly → recap post synthesizing both

Execution flow (rendered)

flowchart TD
  A[Queue meaningful batch] --> B[Ship implementation]
  B --> C[Capture receipts and artifacts]
  C --> D[Write changelog entry]
  D --> E[Update now, projects, roadmap state]
  E --> F[Publish status]

Architecture maps (simple/deep)

Execution architecture maps

Simple view is for quick scan. Deep view adds operational detail for implementation/debug context.

flowchart LR
  Q[Scoped batch] --> I[Implement]
  I --> R[Receipts]
  R --> C[Changelog]
  C --> S[State sync]
  S --> P[Publish status]
    

Publish-time policy

Default all post/changelog/note timestamps to now (or slightly in the past) so merged content appears immediately.

Only use future-dated timestamps when intentionally scheduling publication.

Anti-pattern

Don’t duplicate changelog text in field notes.

Field notes should add insight, not repeat facts.

Also avoid duplicate posts for the same period/topic. Update the canonical post and use aliases when URL changes.

Search posts, pages, changelog

Use ↑/↓ (or PageUp/PageDown) to navigate, Enter to open, Esc to close. Shortcut: ⌘K (or /).