Template - Troubleshooting article

Last updated 28 July 2026

Use this template when writing a new troubleshooting article.

Problem

Describe the problem briefly.

Solution

  1. Add steps that are simple and self-contained

  2. Add illustrations to instructions by typing /image

  3. Stick to 3-5 steps per task to avoid overloading readers

Labels

Do not publish a troubleshooting article without labels. Help-center search treats labels as extra keywords, and request-type auto-search can be gated to a single label — an unlabelled or inconsistently labelled article is silently never suggested on the matching request form.

[USER-ACTION-REQUIRED: Add page labels: troubleshooting, {1-3 feature areas}, {0-3 symptom synonyms}]

  • Content type — always troubleshooting, and only that one. Exactly one content-type label per page.

  • Feature area — 1 to 3 terms naming the subsystem the fix lives in, e.g. output, routing, node-editor, assets, performance, replication. Pick from the closed list only — never invent a term.

  • Symptom synonyms — 0 to 3 terms in the words a customer types, e.g. black-screen, no-signal, blackout. On troubleshooting pages, apply the symptom term even if those words already appear in the body — request-type auto-search reads labels, not body text.

Lowercase and hyphenated, singular where natural (output, not Outputs). A term that is missing from the controlled vocabulary is added to the vocabulary first, then used here.