Troubleshooting Guide Quality Rubric

Purpose

This rubric defines the target standard for every troubleshooting guide in the library. It is intended for maintenance, review, and future expansion work so new guides do not drift back toward short placeholder-style content.

Minimum structural standard

Every model guide should include all of these sections:

The Failure patterns and repair logic section should normally contain:

Plasma-only guides may rename the second and third branches to reflect plasma output, pilot, and transfer behavior as long as the same diagnostic intent is preserved.

Content-depth standard

A strong guide should do all of the following:

A guide is too shallow if it:

Comprehensive field-service tier

The current structural standard is the minimum acceptable guide. The target for a truly field-service-grade guide is higher.

When a guide is pushed to the comprehensive tier, it should also include:

Those sections should add practical value, not padding. For example:

Technician-first presentation standard

For brand-level indexes and shared brand stacks:

The library can include rich training support, but the first path a technician sees should still be the repair path.

Model-specific depth expectations

MIG and flux-cored models

Strong guides should address:

TIG models

Strong guides should address:

Plasma models

Strong guides should address:

Multiprocess models

Strong guides should address:

Engine-driven models

Strong guides should address:

Brand- and platform-specific refinement targets

When source quality permits, strong guides should include:

Source standard

Each guide should prefer:

If source quality is weak, the guide should stay conservative and avoid implying unsupported fault-code detail.

Evidence strength affects source framing, not diagnostic depth. If a model is included in the library, its troubleshooting guide should still be written to the same structural and practical depth standard as stronger-source models, while clearly stating any source limitations in ## Sources or ## Model-specific notes.

Source strength should also not become an excuse to omit baseline checks, expected observations, or repair-verification logic. If exact numbers are not supported, the guide should still explain the diagnostic direction using conservative qualitative observations. If exact numbers are supported, the guide should prefer a checkpoint table over burying those values inside narrative paragraphs.

Repair-enablement reference layer

The model guides should be supported by shared repair references, not treated as isolated documents.

The preferred reference layer now includes:

These references are especially important when a brand has thin public component-level service literature. They let the guide remain repair-useful without overstating unsupported internal detail.

Review standard

A guide should be considered ready when:

Priority refinement rule

If further improvement time is limited, prioritize guides in this order:

  1. High-volume field models
  2. Digitally controlled or feature-rich models where settings drift mimics failure
  3. Plasma and multiprocess units with multiple subsystem boundaries
  4. Industrial packages with feeder, cooler, or mechanized integration
  5. Legacy machines with thin official source support