Workflow Guides
Authoring guides for creating consistent workflow documentation across product areas.
Measurement
Takeoff, calibration, scale, tools, and measurement data workflows.
Annotation
Shapes, markup, selection, visibility, delete, and annotation events.
Files
Open, upload, file tabs, file info, page list, export, and print workflows.
Revision
Prepare, align, compare, save, and revision error handling workflows.
BIM / 3D
Model controls, part selection, walkthrough, explode, transparency, and sections.
Issue Management
Issue markers, task metadata, linked annotation selection, and recovery.
Facility Management
Space hatch boundaries, room metadata, assets, inspections, and issues.
UI / UX
Workflow layout, state, accessibility, and code block authoring rules.
Use these guides before creating or updating workflow docs. Each guide lists the workflows it covers, required pages, NPM APIs to verify, UI expectations, and split rules.
- Use NPM APIs for NPM workflow docs.
- Guides are NPM SDK guidance. PostMessage mode must show an availability notice, not NPM calls.
- Verify APIs against existing NPM component docs before writing examples.
- Link to the component API reference instead of reproducing unsupported payload details.
- Keep examples complete enough to copy into a framework app.
- Use one file per code block.
- Do not use tabbed code blocks in workflow pages.
- Add a verification checklist to every workflow.
