Regulatory and archival documents¶
Documents that must be readable by assistive technology, reviewable before they leave, and reproducible afterwards.
What it produces¶
A tagged, accessible PDF, optionally held for human approval before delivery, with a record of what was produced and when.
How you build it¶
- Build the report, giving every meaningful image and chart a real Alt text
- Use Heading components for structure so the document has a real outline, not just large text
- Request an accessible export by setting
accessible=trueon the API call - Turn on hold-for-review in the job so deliveries wait for approval
- Use the run history as the record of what was generated
What makes it tricky¶
- Accessible export is currently an API option, not a switch in the editor — see the
accessibleparameter in the API reference. - Alt text left empty still produces a valid document, described merely as "Image" or "Chart". That passes validation without helping anyone; write real descriptions.
- Mark ornaments as decorative. A logo in a page master is announced on every page unless it is flagged, which makes a document hostile to read with a screen reader.
- Text that only looks like a heading is not one. Only Heading contributes to the document outline — a Text component in a large font does not.