DevGlossary: strukturovaný Markdown slovník inženýrských termínů pro vývojáře
DevGlossary je otevřený repozitář s programovacími termíny uspořádanými podle témat v Markdownu. Každý záznam obsahuje definici, použití, omezení a vazby na další pojmy. Projekt řeší problém rozmazaných znalostí: termíny jako composition vs aggregation, concurrency vs parallelism nebo bounded context jsou zachyceny v jednotném formátu pro rychlou konzultaci nebo hlubší analýzu.
Slovník byl sestaven z osobních poznámek autora, doplněn GPT pro kostru a uniformizován ve struktuře. Je vhodný pro středně pokročilé a senior vývojáře k ověření interpretací bez čtení celých článků.
Struktura témat a formát záznamů
Témata jsou rozdělena do souborů: Architecture, OOP, Functional, Runtime and Memory, Concurrency, Algorithms and Data Structures, Databases, Networking, Compilers and Languages, Testing, DevOps, Security. Každé téma dodržuje šablonu:
- Obsah.
- Seznam termínů s krátkými definicemi.
- Detailní karty.
Karta termínu zahrnuje:
- Krátkou definici.
- Plnou definici.
- Účel.
- Kdy použít.
- Omezení a chyby.
- Příklady.
- Související termíny.
Toto zajišťuje dva režimy: rychlé hledání (1 minuta) a obnovení kontextu tématu.
Výhody Markdown formátu
Markdown byl vybrán pro jednoduchost:
- Čtení na GitHubu bez konverze.
- Editace v jakémkoli editoru.
- Snadné odeslání PR.
- Možnost exportu na web, PDF nebo DOCX.
Struktura repozitáře:
DevGlossary/
├─ README.md
├─ INDEX.md
├─ assets/
│ └─ cover.png
└─ topics/
├─ _template.md
├─ architecture.md
├─ oop.md
└─ ... (ostatní témata)
INDEX.md je vstupní bod s navigací. Šablona _template.md zaručuje jednotnost.
Cílová skupina a hodnota
Projekt je určen pro:
- Vývojáře, kteří systematizují terminologii.
- Týmové lídry a architekty pro sjednocení pojmů v týmu.
- Speciality potřebující přesné formulace bez dlouhých textů.
Slovník osvěžuje paměť, propojuje pojmy a zabraňuje záměnám (idempotency s optimistic locking, concurrency s parallelism). Nenahrazuje dokumentaci, ale urychluje přístup k nuancím.
Plány rozvoje
Základní kostra je připravená. Dále:
- Vyrovnání formulací.
- Posílení křížových odkazů.
- Přidání termínů do sekcí.
- Rozdělení velkých témat (Databases, Concurrency, Architecture).
Priorita — databáze, konkurence, architektura, networking.
Co je důležité:
- Jednotný formát karet pro konzistenci.
- Markdown pro nízkou vstupní bariéru příspěvků.
- Zaměření na nuance a vazby termínů.
- Otevřený PR proces pro zlepšení.
- Dva režimy: příručka a konceptuální mapa.
— Editorial Team
Zatím žádné komentáře.