DevGlossary:开发者工程术语的结构化 Markdown 术语表
DevGlossary 是一个开源仓库,将编程术语按主题组织成 Markdown 格式。每条条目包含定义、使用场景、局限性以及相关概念链接。该项目通过标准化如组合 vs 聚合、并发 vs 并行或限界上下文等术语,解决知识模糊问题,提供一致格式,便于快速查阅或深入复习。
术语表源于作者个人笔记,用 GPT 完善结构,并统一格式。特别适合中高级开发者快速对齐理解,而无需阅读长篇大论。
主题结构与条目格式
主题拆分成独立文件:架构、面向对象、函数式、运行时与内存、并发、算法与数据结构、数据库、网络、编译器与语言、测试、DevOps、安全。每主题遵循统一模板:
- 目录。
- 术语列表及简要定义。
- 详细条目卡片。
一条目卡片包含:
- 简要定义。
- 完整定义。
- 目的。
- 使用时机。
- 局限与陷阱。
- 示例。
- 相关术语。
这种设计支持两种模式:快速查阅(1 分钟)和完整主题上下文恢复。
Markdown 格式的优势
选择 Markdown 因其简洁:
- GitHub 上直接查看,无需转换。
- 任意文本编辑器即可编辑。
- 轻松提交 Pull Request。
- 可导出为网站、PDF 或 DOCX。
仓库结构:
DevGlossary/
├─ README.md
├─ INDEX.md
├─ assets/
│ └─ cover.png
└─ topics/
├─ _template.md
├─ architecture.md
├─ oop.md
└─ ... (其他主题)
INDEX.md 作为入口,提供导航。_template.md 确保一致性。
目标受众与价值
项目面向:
- 系统化术语的开发者。
- 统一团队概念的技术主管与架构师。
- 需要精确定义而非长文的专业人士。
术语表能刷新记忆、连接概念,避免混淆(如幂等性与乐观锁,并发与并行)。它不取代官方文档,而是加速关键细微差别的获取。
开发路线图
核心框架已就绪。后续计划:
- 优化表述一致性。
- 强化交叉引用。
- 扩充各节术语。
- 拆分大主题(数据库、并发、架构)。
优先级:数据库、并发、架构、网络。
关键点:
- 统一卡片格式确保规范。
- Markdown 便于贡献。
- 聚焦细微差别与术语关联。
- 开放 PR 流程改进。
- 双模式:快速参考与概念映射。
— Editorial Team
暂无评论。