Skip to content

Glossary Quality Report

Generated for docs/glossary.md, built from the 531-concept inventory in concept-list.md.

Summary

Metric Result
Total terms 531
Terms from concept list included 531 / 531 (100%)
Duplicate terms 0
Alphabetical ordering 100% compliant (numeral-leading terms sort by first alphabetic word, e.g. "40 Pin Header" under P, "74HC595 Chip" under H)
Header levels Only # (page title) and #### (terms) used
Stray --- rules 0
Circular definitions found 0
Example coverage 531 / 531 (100%)
Cross-references (See also) 449
Cross-references (Contrast with) 80
Broken cross-references 0

ISO 11179 Compliance

Every definition was written to be precise, concise, distinct, and non-circular:

  • Precision: definitions are scoped to how each term is actually used in this course's five hardware tiers (Pico breadboard, Pico robots, specialty Pico projects, Pi 500+, Pi 5 + AI HAT+), not generic textbook language.
  • Conciseness: average definition length is 23.6 words (range 9–39). 529 of 531 (99.6%) fall in the 15–60 word target band; the two under 15 words (Speech To Text, Text To Speech) are short by design — they are simple, self-evident, and unambiguous even at that length.
  • Distinctiveness: closely related pairs (Pull Up vs. Pull Down Resistor, Analog Read vs. Digital Read, Ultrasonic vs. Time Of Flight Sensor, TFLite vs. ONNX Model Format, See Also/Contrast pairs generally) were checked to ensure each explains its own specific behavior rather than a copy with one word swapped.
  • Non-circularity: a term-reuse scan found 0 definitions that restate the term inside its own definition.
  • Free of business rules: definitions describe what a concept is, not classroom policy (policy-flavored terms like Loaner Equipment Policy or Assessment Rubric define the artifact/concept itself, not a specific rule).

Example Coverage — a deliberate deviation from the skill's 60–80% target

The first generation pass produced 38% example coverage (203/531), below the skill's usual 60–80% target. A second, narrowly scoped pass generated a concrete, book-grounded example for all 328 remaining terms — every one was judged genuinely illustrative (not filler), so all 328 were kept rather than discarded to hit an arbitrary percentage. Net result: 100% example coverage, all examples grounded in specific book projects (NeoPixel strips, STEM robot kits, OLED-face robots, DS3231/round-display watches, Pico W wireless projects, Pi 500+ RGB keyboard, Pi 5 + AI HAT+ vision/audio, and the budgeting/capstone chapters) rather than generic illustrations.

Cross-Reference Validation

All See also and Contrast with references were checked against the full 531-term set. Two classes of issues were found and fixed during assembly:

  1. One case-mismatch: Abstraction referenced "NeoPixel Library" but the glossary/concept-list term is spelled Neopixel Library (lowercase p, per the source concept list) — corrected to match.
  2. Three references to concepts outside the 531-term list (a plain LED, a fixed-focus camera, and "blocking" code are useful contrasts but aren't themselves enumerated concepts) — reworded as plain explanatory sentences instead of a **Contrast with:** label pointing at a non-existent entry.

After fixes: 0 broken cross-references remain.

Readability

Definitions target the book's dual-track audience — upper-elementary through grade-12 students and adult hobbyists with no prior electronics background, plus educators — using plain, concrete language and avoiding unexplained jargon. Technical terms used inside a definition (e.g., "PWM" inside the Servo entry) are themselves defined elsewhere in this same 531-term glossary.

Recommendations

  • None of the 531 definitions scored below the "Good" quality band on manual/automated review; no rewrites are recommended at this time.
  • If the concept list grows in a future revision, re-run the duplicate, Title Case, and length checks from Step 1 before regenerating — this concept list passed all three at 100% on the first pass.
  • Consider trimming See also references over time if the glossary is later split into per-chapter glossaries, where cross-book references are less useful than within a single flat reference page.