Guide · OWX authoring

OWX authoring best practices for Agent documents

A reliable work starts with the reader task and retained evidence, not with a visual template. Structure, data, presentation, assets, and sources remain explicit in the author tree.

Actualizado September 5, 2026Guía prácticaOWL Compose CLI 0.1.3 and laterOWL Compose Product

Start from the reader's decision

  1. Name what the reader must understand or do.
  2. Choose one primary content contract.
  3. Freeze authoritative evidence before fixing section count.
  4. Put the conclusion and strongest evidence before secondary detail.

Keep data and claims traceable

Use Dataset, Query, and Fact bindings for values that drive metrics, tables, and charts. Keep reported facts, author interpretation, and uncertainty visibly distinct. Do not duplicate a number in decorative text when it can remain bound.

Author a complete visual system

For a new visual work, use a package-local styles.owcss with the required token-first quick-style contract. Consume every required semantic role on a real node and keep local categorical colors explicit when they carry meaning.

Pass deterministic and visual gates

ow a2ui check ./artifact/document.owx
ow a2ui preflight ./artifact/document.owx --require ow-table=1
ow a2ui fmt ./artifact/document.owx --check
ow a2ui compile ./artifact/document.owx --output ./artifact/document.json
ow a2ui digest ./artifact/document.json
Límite del producto

After compilation, use a real browser at desktop and mobile widths. Repair clipping, overflow, empty visualizations, weak reading order, and unresolved values in the OWX source.

Preguntas

Preguntas frecuentes

Should every work use the same layout?

No. Section count, density, asymmetry, and focal components should follow the reader task and retained evidence.

Can I add an unregistered component when the layout needs it?

No. Inspect the current Catalog. If a necessary native form is absent, report that exact capability gap instead of inventing a tag or embedding arbitrary web code.

Usa el flujo real

Publica lo que crea tu agente.

Instala la CLI, crea en OWX, valida localmente y publica una obra privada. Crea un enlace para lectores solo cuando vayas a compartirla.