DocGen Authoring UX Parity Audit¶
Date: 2026-06-17
Scope¶
This audit checks whether each seeded DocGen example can expose its JSON- or fixture-backed document configuration through the demo authoring UX.
| Example | Org | Source | UX parity covered |
|---|---|---|---|
| Odyssey Phoenix memo | odyssey |
odyssey-phoenix-firm-order.json |
Document settings, fields, data needs, sections, compute inspector |
| GOA background check | goa |
goa-background-check.json |
Document settings, fields, data needs, sections, schema compiler |
| AltaML DealDesk proposal | altaml |
altaml-dealdesk-proposal.json |
Document settings, fields, data needs, sections, schema compiler |
| AltaML DealDesk SOW | altaml |
altaml-dealdesk-sow.json |
Document settings, fields, data needs, sections, schema compiler |
| Vertical Scope proposal | vertical-scope |
vs-carbon-media-proposal.json |
Document settings, fields, data needs, sections, schema compiler |
| Tomorrow Law JBRK post-mortem | tomorrow-law |
Python fixture | Document settings, fields, sections, snippet bindings, compute inspector |
| Tomorrow Law JBRK inter vivos | tomorrow-law |
Python fixture | Document settings, fields, sections, snippet bindings, compute inspector |
Automated Coverage¶
demo/e2e/docgen-example-ux-parity.spec.ts adds:
| Test area | What it verifies |
|---|---|
| Org switching | The real dropdown switcher moves through all five seeded orgs and each document list updates without leaking the previous org's documents. |
| Document controls | State, verification, section heading, synthesis model, and gather model controls are visible for each example document. |
| Fields | JSON/fixture fields exist through the API and are visible/editable through the field metadata dialog. |
| Data needs | JSON data needs exist through the API and are visible/editable through tool or prompt data-source dialogs. |
| Sections | Seeded section titles and render modes are visible; templated, composed, and prompt-style section drawers expose their mode-specific controls. |
| Snippet bindings | JBRK snippet bindings are visible and count-match the document snippet API. |
| Compute inspector | Computed hooks that can fire from seeded fields, such as JBRK, are visible in the read-only inspector. |
| Schema compiler | Every declarative example spec validates and dry-runs through the Schema Compiler tab. |
Design-System Audit¶
The demo app uses the repo's design:audit guardrail:
| Guardrail | Result |
|---|---|
No unreviewed CSS modules under demo/app |
Pass |
No inline style={{ ... }} in app source |
Pass |
No native button, input, select, or textarea outside documented exceptions |
Pass |
Authoring controls use altaforge-ui / docgen-ui primitives |
Pass |
Remaining Limits¶
| Limit | Current status |
|---|---|
| Compute-hook authoring | The UX can inspect fired compute hooks but does not author/register compute functions. Vertical Scope's vs_inventory hook self-gates until gathered.brief exists, so the pre-generation authoring test cannot assert it in the inspector. |
| Python-fixture examples | JBRK is still fixture-backed rather than schema-compiled JSON, but its seeded fields, composed sections, snippet bindings, and compute output are visible through the UX. |
| Generation output parity | This suite validates authoring/configuration parity, not final generated prose or DOCX/PPT output. Existing generation tests should remain separate. |