meta

XRAYN Vault Style Guide

The voice is engineer-credible, buyer-useful, no marketing fluff, no fake numbers.

Voice

What belongs in each entity type

System Card: spec that buyers use to decide, parts buyers will need, field guide pointer, licensing that affects value, acceptance-test checklist, licensing/variant differences.

Field guide: engineer-voice tribal knowledge. Most-common failures, what to check first, things nobody writes in the service manual. Safety warnings where real.

Part: what it does, where it fits (all variant slugs), typical failure mode, field-guide cross-ref. No price numbers.

Glossary: plain-language definition in one paragraph. Why it matters to buyers. Why it matters to engineers. Heavy backlinks.

Manufacturer: company history, product lines (cross-linked), market position per modality, acquisitions / spinoffs.

Modality: physics, history summary, key specs that drive purchase decisions, competitive landscape, service reality that differs from other modalities.

Clinical application: what the procedure is, which systems are typically used, room-time ranges, specialty.

Forbidden

Linking

Tags

Every entity gets a tags: frontmatter array. Standard tags:

Citation

When a specific claim depends on an external source, cite inline with a markdown link or at the bottom under ## Sources. Sources are not required but welcomed where they strengthen the claim.

Versioning

When you change a fact on an existing page, update the frontmatter updated: field (YYYY-MM-DD). When you rewrite an entity more than 50% from scratch, increment a version: N in frontmatter.