Skip to content

[product-pages] Em-dash refactor (74+ hits) across FEATURES + intro + ARCHITECTURE #76

Description

@rubenvdlinde

Source: AUDIT-product-pages-2026-05-13.md fleet audit · finding: 74+ em-dash hits across FEATURES.md (66), intro.md (8), and ARCHITECTURE.md

The design-system writing rules (design-system/CLAUDE.md):

No em-dashes (—). Replace with a period, comma, colon, or parenthesis. A short follow-up sentence is almost always better than an em-dashed aside.

Em-dashes are also the dead giveaway of LLM-generated copy. Conduction copy reads like a person wrote it.

Scope

Refactor every em-dash in the migrated files (which the migration PR moves into Features/ and Technical/):

  • Features/features.md (was FEATURES.md) — 66 hits
  • intro.md — 8 hits, and the 48-word sentence describing four audiences must be split
  • Technical/architecture.md (was ARCHITECTURE.md) — multiple hits, esp. the "All persistent state — ... — lives in OpenRegister" pattern

Replacement rules

  1. Em-dash separating two sentences → period.
  2. Em-dash as parenthetical → comma + comma, or parentheses.
  3. Em-dash as list separator → split into proper bullet list.
  4. Long sentence with em-dash → split into two sentences under 16 words each.

Acceptance

  • grep -c "—" docs/ returns 0 (or only counts em-dashes inside <code> blocks if any).
  • No sentence exceeds 16 words in user-facing copy (Technical/ ADRs can be longer).
  • Tone audit on the worst section of FEATURES.md confirms it reads MKB-direct, not analyst-report.

Activity

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

    documentationImprovements or additions to documentationproduct-pages-auditAudit finding from 2026-05-13 fleet review against design-system product-pages spectier:3Content authoring, separate sprint

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions