Uninote
Uninote
用户根目录
brdr
common
programming
docs
后端试题
问题讨论

文档导航

  • 本目录保存 Markdown Editor 的架构、阶段设计、验证基线和托管同步专题文档。
  • 根目录 README 提供项目概览、关键行为与常用命令,功能说明 记录当前用户可见能力。

文档职责

文档 主要内容 适用场景
技术架构与实施计划 当前架构、关键决策、演进边界、阶段状态和路线图 理解全局设计或评估后续方案
阶段 0 工程基线 自动化验证、性能基准和人工回归清单 发布验证或检查工程基线
阶段 1 可靠性设计与验证 保存、编码、恢复、外部修改和交互可靠性 修改编辑、保存或恢复流程
阶段 2 桌面笔记库设计与验证 笔记库、目录树、文件操作、搜索和设置 修改工作区或文件管理能力
预览编辑器产品设计 Preview、Normal、Pinned 与 Dirty 状态及交互规则 修改标签打开、保留、固定或批量关闭行为
阶段 5 账号与托管同步 Beta 服务运行、数据模型、协议、安全、备份、容量和灰度 部署、运维或修改托管同步
同步流程与代码位置 同步调用链、源码映射、持久化边界和排障指南 定位同步实现或分析故障

推荐阅读路径

使用与功能确认

  1. 阅读根目录 README,了解运行、验证和构建方式。
  2. 阅读功能说明,确认界面能力和快捷键。

架构与开发

  1. 阅读技术架构与实施计划,了解系统边界和既有决策。
  2. 根据修改范围进入对应阶段文档。
  3. 涉及同步时,再阅读同步流程与代码位置阶段 5 文档

发布与运维

  1. 阶段 0 工程基线执行自动化验证和人工回归。
  2. 部署同步服务时,按阶段 5 文档检查安全、备份、恢复和灰度要求。

维护约定

  • README 保留项目入口、关键行为摘要、常用命令和文档索引,不承载完整协议或实现细节。
  • FEATURES 只描述当前已交付且用户可观察的行为,不记录规划中的能力。
  • phase-* 文档记录对应阶段的设计、限制、验证和运维要求。
  • sync-flow.md 维护实现调用链、源码位置和排障入口;协议字段以阶段 5 文档为准。
  • 同一主题只指定一个主要维护位置,其他文档使用链接引用,避免复制后产生差异。
  • 功能、命令、配置、协议或架构发生变化时,同一提交内更新相关文档。
  • 多个独立事实分行书写;复杂内容使用小节、列表或表格表达。
  • 所有文档使用 UTF-8 编码和 LF 换行。

README

keyboard-mvp

点赞(0) 阅读(11) 举报
目录
标题