mirror of
https://github.com/qingjian-team/qingjian.git
synced 2026-11-06 16:13:55 +00:00
yenharvey
7a2ccc7691
青简（Qingjian）：用 Rust 写的拼音输入法，候选词旁多一条正在学的那门语言的译词，一次只学一种。 核心引擎平台无关（crates/），macOS 输入法（apps/macos）已可用，CLI 测试工具（apps/cli）， 产品数据生成工具（tools/），设计文档、计划与用户文档在 docs/，发版流程见 docs/notes/release.md。
1.6 KiB
1.6 KiB
docs
README.md 只介绍项目，所有技术内容放在这里，分四类：前三类是给开发者看的内部文档，user/ 是给用户看的、官网渲染的文档。
| 目录 | 放什么 |
|---|---|
| design/ | 设计：现在是什么样、为什么这么定 |
| plan/ | 计划：接下来做什么、按什么顺序 |
| notes/ | 工程记录：性能优化史、事故复盘、踩坑，按时间顺序写，以后复习与面试用 |
| user/ | 用户文档：官网「文档」页的内容源，按目录结构渲染；维护约定见 user/README.md |
| 文件 | 内容 |
|---|---|
| design/architecture.md | Core 与平台层的划分、crate 结构、必须遵守的架构约束、.qj 数据容器 |
| design/candidate-ui.md | 候选窗口、按键约定与翻译 annotation 的设计 |
| design/landscape.md | 同类项目（水杉、Rime）、可用数据源及其许可 |
| plan/roadmap.md | 分阶段路线图、各阶段的依赖关系与已完成项 |
| plan/todo.md | 待办清单，按「从自用到能给别人用」排 |
| notes/performance.md | 历次性能优化：起因、定位方法、改法、数字前后对比与经验 |
| notes/release.md | 发版流程：CHANGELOG、标签触发的 CI 打包、产品数据包、签名公证的 Secrets、官网用的 releases.json |
约定：文档写中文，代码标识符一律英文。实现与文档产生分歧时以代码为准，并同步更新文档。