Guides
Guides are grouped by the document-building task you have in mind. The times assume you already know your way around the editor.
Creating and structuring documents
Section titled “Creating and structuring documents”- Create a document from a template. Choose from 114 templates or start blank, name it well, and open it in the Document Builder. (~10 min)
- Build content with components. Add headings, paragraphs, tables, lists, callouts, requirements, and structured blocks with the slash command or the component library. (~20 min)
- Build reusable documents with input variables. Define named inputs, insert tokens into components and properties, and expose them to Automation through a saved template. (~15 min)
- Organize and navigate with the outline. Use the outline tab, headings, nest levels, and drag handles to structure a long document. (~15 min)
Styling and publishing
Section titled “Styling and publishing”- Design a document. Apply typography presets, paper themes, headers, footers and brand kits, then control pagination with Page Breaks and Section Breaks. (~15 min)
- Export a document. Hand off the document as PDF, Word, or Markdown. (~5 min)
- Version history and publishing. Save checkpoints, publish versions, restore, and compare. (~10 min)
Collaboration and references
Section titled “Collaboration and references”- Link artifacts and comments. Connect components to related artifacts and leave component-level comments. (~10 min)
- Use reference components. Add glossaries, acronyms, definitions, key-value lists, tables of contents, and version history blocks. (~15 min)
Common situations, fast
Section titled “Common situations, fast”- Need to start a requirements document? See Create a document from a template and pick the Business Requirements template.
- Need to add a table of contents automatically? See Use reference components.
- Need a styled handoff PDF? See Export a document.
- Need one landscape page for a wide table? See Layout and page breaks.
- Need to restore an earlier draft? See Version history and publishing.
- Need to change the look of one section only? See Design a document for component-level style overrides.
- Need Automation to fill a document? See Build reusable documents with input variables, then Generate documents with input variables.