Driver Design Diagnostics
Nimbus analyzes the driver design and reports problems as diagnostics, each identified by a
stable ID (for example, NIM0001). The same analysis runs in two places, from one shared rule
engine, so results are consistent:
- Live, in Visual Studio — as the driver is edited, diagnostics appear in the Error List.
- At build time — on command-line and CI builds, the analysis runs as part of the build and a diagnostic configured as an error fails the build.
Each diagnostic has a configurable severity, which determines whether a given check is an error, a warning, informational, or disabled. See Configuring Driver Design Analysis.
Opening what a diagnostic reports
Section titled “Opening what a diagnostic reports”Double-clicking a diagnostic in the Error List navigates to its subject, whether it came from the live analysis or from a build:
- A diagnostic about an authored file, such as a broken link in a conceptual topic, opens that file at the line and column concerned.
- A diagnostic about authored help content, such as a broken link in a member’s Remarks, opens the Driver Designer at that member, with its Help tab and the field in question already selected. There is no file to open in this case: the content lives in the driver design, which is edited through the designer rather than as text.
Diagnostics
Section titled “Diagnostics”| ID | Summary |
|---|---|
| NIM0001 | Broken help link |
| NIM0002 | Missing help content |
| NIM0003 | Ambiguous help link |
| NIM0004 | Malformed Help Viewer topic |