Developer Portal and Documentation Ops Templates

This appendix provides starter templates for service catalog, documentation ownership, disaster-domain planning, and living-book maintenance.

Quantum catalog entity

Illustrative listing · yaml

apiVersion: quantum.platform/v1
kind: QuantumService
metadata:
  name: sampler-prod-small
  owner: team-quantum-platform
  support: quantum-platform-help
  lifecycle: production
spec:
  service_tier: governed-research
  modality: gate-model
  allowed_patterns:
    - benchmark-clifford
    - qaoa-small
  runtime_contract: sampler-prod-small-v6
  evidence_schema: qevidence.v7
  slo:
    admission_success_rate: 0.98
    evidence_package_completion_rate: 0.995
  docs:
    overview: docs/services/sampler-prod-small/index.md
    runbook: docs/runbooks/sampler-prod-small.md
    evidence: docs/evidence/qevidence-v7.md

Diagram loads as you read

Quantum catalog entity · Figure 1

View diagram source

flowchart TB
    Service[Quantum service] --> Runtime[Runtime contract]
    Service --> Patterns[Allowed patterns]
    Service --> Evidence[Evidence schema]
    Service --> Docs[Docs]
    Service --> Owner[Owner]

Documentation front matter

Illustrative listing · yaml

title: Sampler Production Small Runbook
owner: team-quantum-platform
reviewers:
  - calibration-lead
  - evidence-lead
related_catalog_entity: sampler-prod-small
classification: internal
last_reviewed: 2026-04-20
review_by: 2026-07-20
applies_to:
  - runtime_contract: sampler-prod-small-v6
  - evidence_schema: qevidence.v7

Disaster-domain record

Illustrative listing · yaml

domain_id: qdr-provider-runtime-us-east
scope: provider runtime for governed research workloads
failure_modes:
  - runtime API unavailable
  - queue latency exceeds policy
  - backend disabled by provider
recovery:
  rto: 4h
  rpo: 0 evidence packages lost
  rco: recovered jobs must attach to verified baseline
approved_reroutes:
  - simulator-prod-noisy
  - alternate-provider-small-gate-model
blocked_workloads:
  - regulated-chemistry-claim-bearing

Diagram loads as you read

Disaster-domain record · Figure 2

View diagram source

flowchart LR
    Domain[Disaster domain] --> Failure[Failure modes]
    Domain --> Objectives[Recovery objectives]
    Domain --> Reroutes[Approved reroutes]
    Domain --> Blocked[Blocked workloads]

Documentation pull-request checklist

Illustrative listing · markdown

- [ ] Owner and review-by date are present
- [ ] Related catalog entity is linked
- [ ] Mermaid diagrams render
- [ ] Links resolve
- [ ] Code snippets or CLI examples were tested
- [ ] Operational warnings are explicit
- [ ] Deprecated guidance is marked, not silently removed
- [ ] Source-backed current-state claims have reference IDs

Diagram loads as you read

Documentation pull-request checklist · Figure 3

View diagram source

flowchart LR
    PR[Docs PR] --> Metadata[Metadata check]
    PR --> Build[Build check]
    PR --> Review[Review]
    Review --> Publish[Publish]

Living-book release checklist

Illustrative listing · markdown

- [ ] New chapters are listed in SUMMARY.md
- [ ] New chapters are listed in mkdocs.yml
- [ ] All linked files exist
- [ ] Mermaid blocks are counted
- [ ] Reference IDs used in text are defined
- [ ] README version and chapter range are updated
- [ ] Build manifest is updated
- [ ] Zip package integrity check passes

Diagram loads as you read

Living-book release checklist · Figure 4

View diagram source

flowchart TB
    Release[Book release] --> Nav[Navigation]
    Release --> Build[Build checks]
    Release --> References[References]
    Release --> Package[Zip package]
    Release --> Notes[Release notes]