Message APINPM Package/docs/guides

Workflow Guides

Authoring guides for creating consistent workflow documentation across product areas.

Guide Index

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.

Global Workflow 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.