Home

XKit

XKit 是独立的 Go 基础工具库，为业务开发提供通用功能支持。包按领域分组：Context、可观测性、弹性容错、存储、分布式协调、消息队列、配置、生命周期、安全与通用工具；遵循语义化版本，TDD 开发，整体测试覆盖率 ≥ 90%。本 Wiki 由仓库 docs/ 目录生成，只记录当前可用能力，不追溯历史演变。

go get github.com/omeyang/xkit

主分区

#	类别	入口	说明
01	关键决策（ADR）	05 · 关键决策记录（ADR）	8 篇架构决策记录
02	进度追踪	06 · 进度追踪	包稳定性矩阵 + 实测覆盖率
03	约定规范	XKit 公开 API 清单	API 清单 + 贡献流程
04	包详情	包索引（MOC）	每个包一页详细文档 + 子域索引
05	概念笔记	概念笔记（MOC）	跨包概念（错误处理、并发、可观测性等 10 篇）
06	设计模式	设计模式（MOC）	重复出现的解题模板（Cache-Aside / Distributed Lock 等 8 篇）
07	术语表	术语表	FG-H / FP / slot / CA/CB/Codex / typed-nil 等

设计目标 / 约束 / 业务场景 / 质量指标 直接看 README + CLAUDE.md，避免在多处同步漂移。

顶层外部入口

• README.md - 项目首页
• CHANGELOG.md - 版本变更
• /llms.txt - AI 索引文件
• llms-full.txt - 全文拼接（CI 产物：Actions 工作流附件 + tag 上附加到 release；本地 task docs-llms 生成）
• pkg.go.dev/github.com/omeyang/xkit - Go API 参考

浏览建议

• 首次了解：README → CLAUDE.md → packages MOC
• 想用某个包：直接进 包索引（MOC）
• 想理解某个范式：概念笔记（MOC） 或 设计模式（MOC）
• 查简写：术语表
• AI/RAG 喂入：用 CI 生成的 llms-full.txt（见上方"顶层外部入口"段说明）

文档原则

• 只记当前状态：历史演进入 CHANGELOG.md
• 单一职责：一份文档一个主题
• 单文件 ≤ 800 行
• 决策留痕：ADR 含被拒方案
• 代码溯源：涉及代码的结论引用包路径
• 链接优先：跨主题用相对路径链接，不复制内容