Documents

Specifications and other documents. A document is an Artifact whose sections and requirements are its decomposed by children, numbered hierarchically.

Where to find it

• In the navigation rail: Needs & Requirements → Documents.
• A document opens at documents/<id>; ?baseline=<id|latest> shows a baseline and ?find= searches.

Main actions

• Document list: filter and sort the cards; the top bar has Import and + New Document (type, name and number, then a template). × on a card offers Delete Artifact Only or Delete with Contents.
• Top bar in a document: + New <Class> adds an item; its ▾ offers Add Existing Entity…, Insert Document… (compilations), other statement classes and Other class…. The ✦ AI ▾ lists the document's AI tools.
• Toolbar: + After ▾, + Child ▾, ⇤ ⇥ ↑ ↓, Remove ▾ (Remove from Document, Delete from Database…), ⚙ View ▾, Reports, Open ▾, More ▾ and Find (⌘F).
• Quick entry under the document: type a requirement and press Enter; the section list chooses where it goes. ⌘↵ adds a sibling of the selected item, ⌥⌘↵ a child.
• Left pane: Outline (drag items before, after or into others; Show Position in Outline), Filter (class pills, labels with AND/OR), Baselines and Comments. In a narrow window the pane opens as an overlay; ‹ hides it.
• Click a row to select it; its details appear in the inspector. Click a field to edit it in place. Empty cells show “—”.
• More ▾ for the selected item: Auto Number (from here)…, Descending Bulk Attribute…, Lock Entity, Move…, Quality Check, Splitter… (by sentence or paragraph, or with AI), Transform…, and AI generators. For the document: Acronym Extractor…, Suspect Links, TBD/TBR Register, Functional Analysis (functions, FFBD, tables)…, Auto Number…, Baseline…, Find And Replace…, Quality Check, Template…, Save as Template…, Delete Document….
• ⚙ View ▾: Collapse All, Expand All, Collapse Children, Reset View, Display Options… (columns and settings such as paper mode, S/T/V gap indicators and automatic renumbering), Paper Mode, Hide/Show Outline and Filters.

Baselines and approvals

Baselines tab → + Create Baseline with a name and the approvals (one row per approver: name, role, statement). Approval records are dated and locked; Edit can rename the baseline and add records but never changes existing ones. Selecting a baseline shows it read-only with Back to Main, Edit, Changes Since, Revert to Baseline and Delete. Baseline Change Report compares two baselines, or a baseline and now, and exports XLSX.

Reports

Basic Document Output (DOCX with contents) fills the Revision History and Approvals tables from the document's baselines. Others: Document Outline Report (DOCX), Basic Tabular Output (CSV), Comment Report, Quality Checker Report, RVTM, VCRM, RVM, RTM, RSM and TVM (XLSX), ReqIF, change reports, Markdown, Document Export (JSON) and Print / PDF.

Tips

• Numbering continues the sibling pattern (1.2 → 1.3, a → b, roman numerals, “Appendix A”).
• Filtering or sorting pauses authoring until it is cleared (⚠ Filter/Sort Active).
• ⚠ Suspect on a row means an upstream requirement changed; Quality: stale — re-run means the text changed after the last check.

Related

Write and Trace Requirements · Requirements, Status and Approval · Acronym Extractor · Review Packages