Skip to main content

Writing standard

  • Write in active voice.
  • Write to the reader as you when practical.
  • Keep sentences concise and focused on one idea.
  • Start with a precise summary before moving into explanation.
  • Write canonical pages as commentary-heavy textbook chapters, not as copied standards text.

Naming rules

  • Use the official standard code as the canonical identifier.
  • Use the official standard title in metadata and early in the page.
  • Treat topic names, common aliases, and search phrases as secondary discovery aids.

Content boundary

  • Do not publish raw standards text as the main page body.
  • Do not present generated summaries as a substitute for the official source.
  • Do not hide uncertainty. Flag ambiguity instead of smoothing it over.
  • Do not draft a public page directly from a PDF without first creating an ingestion brief.

Commentary policy

  • The canonical page may rewrite, interpret, and comment on the standard.
  • Commentary should be blended into one main narrative rather than split into a separate explainer page in v1.
  • Interpretive language should stay anchored to the source and should not invent requirements the source does not support.

Example policy

  • Use examples selectively.
  • Add an example only when it resolves a hard judgment or a recurring misunderstanding.
  • Do not add examples as routine filler.

Traceability rules

  • Every canonical standard page must show visible source references.
  • References should be paragraph-level where the source supports it.
  • If paragraph-level mapping is missing, the page is not ready for publication.

Supporting material policy

  • Appendices, illustrative examples, basis-for-conclusions content, and similar material can support commentary.
  • When used, supporting material must be labeled clearly as supporting or interpretive.
  • Supporting material should not be blended as if it were itself the core mandatory requirement.

Status model

Use status labels consistently:
  • Current
  • Amended
  • Superseded
If a page is current, show what it supersedes where relevant. If a page is superseded, show what replaced it.

Intake workflow rule

The required internal order is: PDF -> source object -> ingestion brief -> canonical page draft -> review gate -> publish If a bundled PDF contains multiple standards or amendments, split it into separate source objects before drafting.

Comparison policy

Cross-framework comparison content is a separate page type. It should summarize differences and links, but it should not replace the canonical framework pages.