Gold Standard Topics
Use these examples when you want to see what a strong troubleshooting topic looks like in practice.
Examples
Section titled “Examples”- Smart Cart Not Waking Up Aircraft: Good example of a longer troubleshooting flow that starts with physical checks, moves into software checks, then hardware-specific checks.
- Asset Offline Due To Comms OR Provisioning Agent Error: Good example of splitting a complex topic into multiple troubleshooting sections. It also has a strong table that maps command output/errors to next steps.
- RX_V2V_ABSENT: Good example of embedding Baraza telemetry directly in a troubleshooting flow, using clear nominal and off-nominal screenshots, and routing missing or inconclusive telemetry before escalation.
What To Look For
Section titled “What To Look For”A gold-standard topic should be easy to follow under pressure. Look for:
- A clear title and description that match the actual problem.
- One of the three workflow outcomes: resolve the issue, escalate to the right contact, or send for maintenance.
- A decision flow that moves naturally down the page without making the reader jump around.
- Questions with clear Yes/No or option labels that are not easy to misunderstand.
- Action steps that tell the reader exactly what to do, where to look, and what result matters.
- Links, screenshots, tables, or code blocks only where they make the step easier to complete.
- Escalation steps that name the right channel/team and explain when to use them.
- Background information that supports the workflow without burying the troubleshooting steps.
- No stale notes, raw engineering scratch text, or unexplained internal shorthand.