XRAYN Vault Style Guide
The voice is engineer-credible, buyer-useful, no marketing fluff, no fake numbers.
Voice
- Direct. "The klystron is the wear item. Budget for replacement." Not "The klystron is a critical component that may require service."
- Concrete. Specific part numbers, specific software revisions, specific model-year ranges. When unsure, say "typical" or "depends on rev."
- Useful. Every paragraph should help a buyer, engineer, or operator do their job better.
- Honest. "5-9 year useful life (pre-2009 panels: 3 years)." Not "long-lasting performance."
- No marketing language. Never: "cutting-edge", "revolutionary", "seamless", "unparalleled", "state-of-the-art".
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
- No fake numbers. No invented K-numbers, serial counts, MAUDE report counts, install-base totals. If unsure, use qualitative ("major install base", "widespread").
- No fake listings. Listings come from real Supabase data; we don't fabricate refurb sellers or prices.
- No fabricated companies. No service-org names until they've opted into a seller agreement.
- No scraped product imagery. Use OEM press-kit assets, seller-contributed, or silhouettes.
- No prices. No dollar ranges in any part / system / listing. Always "Request" or "Market data pending."
Linking
- Every wikilink uses absolute vault paths:
[Super-C](/wiki/systems/ge-oec/9800-super-c) - Every system card links to: manufacturer, modality, family, sibling variants, predecessor/successor, at least one field guide reference.
- Every part links to: all systems it fits (array), field-guide anchor.
- Every glossary term links to: at least two systems that use the concept, related glossary terms.
Tags
Every entity gets a tags: frontmatter array. Standard tags:
system,variant,family,part,manufacturer,modality,schema,field-guide,glossary,clinical-application,persona,regulatory,standard,conference,history,meta,folder-note- Modality tags are composed:
modality-ct,modality-mri, etc.
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.