Skip to main content

Quick Reference Tagging Standard (core.help)

Use consistent help tags so UI components can resolve docs quickly.

Key format​

app.module.feature.intent

Examples:

  • admin.users.invite.start
  • operator.forms.instances.create
  • operator.auth.mfa.verify
  • pilot.logbook.entry.submit

Tag categories​

  • quick-ref: short guidance for immediate action
  • why-it-matters: policy, compliance, or safety context
  • common-mistake: avoidable failures
  • support: troubleshooting and escalation
  • advanced: optional deeper details

UI placements​

  • Field-level icon for complex fields
  • Section header chip for workflows
  • Empty-state help banner
  • Error state learn-more link

Component behavior​

  • HelpChip opens quick reference panel
  • HelpPanel includes short answer plus related links
  • Tooltip preview should be one sentence max

Content constraints​

  • Use role-aware text when permissions differ
  • Keep quick-ref summary under 280 characters
  • Always include link to full doc article