Skip to content

markdown-format: internal fleet-audit jargon (dim N, fleet wave, medley, sibling-plugin names) in consumer-facing shipped text #425

Description

@kyle-sexton

Plugin: markdown-format · Category: hardcoded internal vocabulary (1) — low severity
Source: work-readiness sweep (read-only audit vs docs/PLUGIN-PHILOSOPHY.md + docs/MIGRATION-PLAYBOOK.md)

Findings

  • plugins/markdown-format/CHANGELOG.md:13 — "the fleet's other hook-plugin setups"
  • plugins/markdown-format/CHANGELOG.md:19-20 — "(fleet conformance wave, dim 8 — the fleet's first conforming exemplar)"
  • plugins/markdown-format/CHANGELOG.md:35 — "the guardrails plugin's git guards" (names a sibling plugin)
  • plugins/markdown-format/hooks/markdown-format.sh:51,154 — "(dim-9 doctrine)"
  • plugins/markdown-format/hooks/markdown-format.test.sh:7,204,206,208 — "medley-policy prose" / "medley policy tail" (internal monorepo name)

Why flagged

"dim 8"/"dim-9 doctrine"/"fleet conformance wave" are internal fleet-audit dimension jargon; "medley" is the org's internal source monorepo. CHANGELOG is definitively consumer-facing (consumers read it on version bumps per MIGRATION-PLAYBOOK's version-pinning section), so an external consumer reads maintainer-only vocabulary that means nothing to them. Also violates the "never cross-reference file/plugin names" rule (naming the guardrails plugin). Strength order: CHANGELOG > code comments > test comments.

Fix direction

Prose-hygiene rewrite from the consumer's POV — describe what changed and why in consumer terms; keep internal audit jargon and sibling-plugin names out of shipped files. Not a config seam.

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: highSignificant impact, or blocks an imminent release; staff this cycle.status: readyTriaged, unblocked, and fully specified; eligible to pick up.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions