DevGlossary: Structured Markdown Glossary of Engineering Terms for Developers
DevGlossary is an open-source repository of programming terms organized by topic in Markdown format. Each entry includes a definition, use cases, limitations, and links to related concepts. The project tackles the issue of fuzzy knowledge by standardizing terms like composition vs. aggregation, concurrency vs. parallelism, or bounded context in a consistent format for quick reference or in-depth review.
The glossary was compiled from the author's personal notes, fleshed out with GPT for structure, and unified in format. It's ideal for mid-level and senior developers to align interpretations without digging through full articles.
Topic Structure and Entry Format
Topics are split into separate files: Architecture, OOP, Functional, Runtime and Memory, Concurrency, Algorithms and Data Structures, Databases, Networking, Compilers and Languages, Testing, DevOps, Security. Each topic follows a template:
- Table of contents.
- List of terms with brief definitions.
- Detailed entry cards.
A term card includes:
- Brief definition.
- Full definition.
- Purpose.
- When to use it.
- Limitations and pitfalls.
- Examples.
- Related terms.
This setup supports two modes: quick lookup (1 minute) and full topic context recovery.
Benefits of Markdown Format
Markdown was chosen for its simplicity:
- Viewable on GitHub without conversion.
- Editable in any text editor.
- Easy pull requests.
- Exportable to websites, PDF, or DOCX.
Repository structure:
DevGlossary/
├─ README.md
├─ INDEX.md
├─ assets/
│ └─ cover.png
└─ topics/
├─ _template.md
├─ architecture.md
├─ oop.md
└─ ... (other topics)
INDEX.md serves as the entry point with navigation. The _template.md ensures consistency.
Target Audience and Value
The project targets:
- Developers systematizing terminology.
- Tech leads and architects unifying concepts across teams.
- Specialists needing precise definitions without lengthy reads.
The glossary refreshes memory, connects ideas, and avoids mix-ups (like idempotency with optimistic locking, or concurrency with parallelism). It doesn't replace official docs but speeds up access to key nuances.
Development Roadmap
The core framework is ready. Next steps:
- Refine wording for consistency.
- Strengthen cross-references.
- Add more terms to sections.
- Split large topics (Databases, Concurrency, Architecture).
Priorities: databases, concurrency, architecture, networking.
Key points:
- Consistent card format for uniformity.
- Markdown for easy contributions.
- Focus on nuances and term connections.
- Open PR process for improvements.
- Dual modes: quick reference and concept mapping.
— Editorial Team
No comments yet.