Error Glossary
Error Glossary is a documentation-focused web application that provides friendly, human-readable explanations for common and cryptic programming error messages. Not "here's how to fix it." Why the error occurs, what the underlying cause is, and how to stop it from happening again.
The Problem It Solves
Every developer has stared at an error message, copied it into a search engine, and landed on a Stack Overflow answer that says "add this line" without explaining why. The error gets fixed. The understanding doesn't. The same mistake happens again in a different context, with a different error message, and the cycle repeats.
Error messages are documentation. They're the system's attempt to tell you what went wrong. But most are written by compiler authors and framework developers, not by technical writers. Precise in ways that help debugger developers. Opaque in ways that frustrate everyone else.
Error Glossary treats them as a documentation problem. Each entry explains the error in plain language, provides annotated code examples showing the problematic pattern, and offers strategies to prevent the error entirely--not just fix it this time.
What It Does
Each entry starts with the error message itself, then breaks down what it means: what assumption you've violated, what the compiler or runtime expected, and why. Annotated code examples highlight exactly where and why the error triggers, with corrected versions alongside for comparison.
The prevention strategies are what make it more than a fix-it reference. Understanding why CS0246 happens means you stop writing the pattern that causes it, not just memorizing the workaround.
Technology
- Languages: CSS (63%), JavaScript (37%)
- Type: Web application
- License: MIT
How It Connects
Error Glossary is the documentation-first philosophy applied to error messages themselves. The same impulse that drives the Glossary on this site (explain AI terminology for people who work alongside developers) and lint-my-lines (enforce comment quality because comments are documentation too). If clear writing is clear thinking, then clear error explanations are clear debugging.
It's also the spiritual opposite of the projects that produce errors. Every developer who's built a tool has written error messages. Error Glossary asks whether anyone has gone back and explained them properly.
Where to Find It
- GitHub: southpawriter02/error-glossary