维刻 Vex
GitHub
维刻 Vex / 文档 / 维刻 Vex 需求说明书

维刻 Vex 需求说明书

需求回答“为什么做、给谁用、什么结果才算合格”,不先规定按钮要由哪个类实现。

版本基线:0.2.2+4,整理日期:2026-10-18。本篇区分已确认方向、已有实现与仍待验收。它不是无条件的完成声明。

1. 产品与用户

维刻 Vex 是以本地 Markdown 文件为中心的写作空间,slogan 是“写下想法,看见脉络”。保留原 V 形标识,使用品牌墨青。

用户 常见任务 最关心什么
日常写作者 随笔、长文、提纲 输入顺畅、不丢内容、阅读舒服
技术作者 代码、表格、公式、Mermaid 源码可控、复杂块稳定、导出可靠
学习者 阅读资料、用导图整理章节 结构清楚、正文和导图一致
多设备用户 在不同尺寸上阅读和修改 手机不挤、桌面高效、系统习惯一致

当前不包含账户、云同步服务、多人实时协作、SQLite 笔记数据库。用户可自行备份文件,但不要把“本地文件”误解为软件已经实现云同步。

2. 用户旅程

mermaid
flowchart LR
  A[打开文件或新建草稿] --> B[记录想法]
  B --> C[调整章节与结构]
  C --> D[阅读和检查]
  D --> E[保存 Markdown]
  E --> F[按需导出分享]
  D --> B

一个常见场景:打开本套教程文件夹,阅读 01;切到源码查看表格;新建自己的学习笔记;用标题建立大纲;保存后导出一份 PDF。每一步都要有清楚的成功、取消和失败行为。

3. 功能需求与验收口径

编号 需求 核心验收标准
F01 新建、打开、保存、另存为、多文档 取消选择器不误报成功;保存失败保留未保存状态
F02 文件夹与大纲 文件列表和当前文档大纲职责分明;章节操作可撤销
F03 即时、源码、阅读、导图及组合布局 共享同一内容与撤销历史,不因切视图产生分叉
F04 基础与扩展 Markdown 标题、列表、引用、链接、图片、表格、代码、数学、Mermaid 可检查源码
F05 元素菜单 表格、图片、链接、代码等有上下文动作;子菜单不被滚动容器裁掉
F06 查找替换 位于编辑区上方,不横跨文件 / 大纲侧栏;当前文档结果可定位
F07 保存与恢复 自动保存默认关;恢复默认开;关闭和失败路径不悄悄丢弃草稿
F08 外部修改保护 检测到磁盘版本与预期不同,不直接静默覆盖
F09 偏好设置 控件对齐、主题与字号可读、语言可切换;保存失败有状态提示
F10 专注与打字机 两个开关独立;打字机随光标使当前行靠近可用编辑视口中线
F11 六种导图布局 右向、左右平衡、放射、向下、组织结构、鱼骨;首批不做时间轴布局
F12 文档水印 正文预览与导出可独立控制;可设文字和透明度,默认不显示
F13 导出与打印 Markdown、HTML、PDF、Word、导图 PNG 和系统打印入口;错误不可伪装成功
F14 演示模式 桌面和手机均可用,导航与工具组在小屏不散落、不遮正文
F15 关于、鸣谢、更新日志 内置只读;桌面单独进程打开文档,手机 / 平板保持对话框
F16 MCP 桌面本机授权访问;默认关,有作用范围和修改确认,不暴露公网服务
F17 安装与更新 原生可安装产物,程序与用户数据分离,发布统一走 GitHub Releases

七类主菜单

文件、编辑、段落、格式、视图、工具、帮助。主题与排版等放在对应视图入口中;macOS 另按系统习惯安放应用级设置和关于。菜单表达用户动作,而不是列出内部类名。手机使用触控适配的菜单形式,不照搬桌面悬停多级菜单。

Mermaid 与原生导图不是一回事

  • Mermaid:用户在代码围栏里写图表语言,渲染流程图、时序图、甘特图、类图等。当前模板目录含 22 类示例,入口和演示应可发现。
  • Vex 导图:把 Markdown 章节投影为可交互结构,切换布局、选节点、返回章节。

“模板有入口”不等于 Mermaid 所有版本语法、全部扩展都已逐项验收。复杂图表与各导出格式的表现必须单独检查。

4. 默认值也是需求

项目 当前默认
自动保存原文件 关闭;开启后可选 2 / 5 / 10 秒延迟
恢复草稿 开启
恢复上次工作区 关闭
专注 / 打字机 关闭,各自独立
水印预览 / 导出 关闭,各自控制
MCP 服务 关闭;启用后默认修改需确认
界面语言 首次匹配系统,支持简中、繁中、英语、日语

恢复草稿开着,不代表正在修改磁盘里的原文件。 这是两个不同机制。

5. 平台与尺寸要求

环境 设计要求 当前边界
Windows 桌面菜单、快捷键、原生安装器 本机已有构建、窗口与安装流程验证
macOS 遵循系统菜单、标题栏与快捷键习惯 有原生工程与 CI,仍需本机 / 真机完整验收
Linux 桌面工作流、原生 DEB 以 CI 和实际发行结果为准,不代表所有发行版
Android 手机单视图,平板最多双栏 有 APK 构建,真实键盘 / 设备覆盖仍待补齐
iOS 手机 / 平板适配 暂无分发证书,保留编译检查,暂不发布 IPA
HarmonyOS 手机、平板、电脑全覆盖是目标 尚缺完整工程、SDK / 插件适配与签名,暂不发布 HAP

小屏优先保证内容可读和操作可达:对话框固定标题和关闭区,只滚动中间正文;设置不能突然切成桌面宽度;弹出菜单不能制造水平滚动条。平板最多双栏,桌面允许三栏,但实际窄窗口仍会降级。

6. 非功能需求

可靠性

  1. 同一文档异步保存串行,不允许旧写入覆盖新写入。
  2. 保存期间继续输入,新增内容仍显示未保存。
  3. 中文输入法候选阶段不误提交、不被界面刷新吞掉。
  4. 草稿保存失败时,不直接关闭并宣称保留成功。

性能与舒适

隐藏的导图不重复生成树和布局;界面重建按状态范围收敛。长文性能应在明确文档规模、设备和最坏延迟下测量,当前不编造帧率或耗时承诺。

视觉目标为接近已确认原型,但“98%”尚无统一量化评测结果。文字对比度、焦点、键盘操作、滚动、错误恢复比单张截图更重要。

安全

本地 MCP 也要鉴权、范围约束和修改确认。当前开发分支令牌通过平台安全存储保存,不再写普通设置;客户端配置仍含敏感令牌,公开日志和备份前应检查敏感信息。配置和能力范围见 MCP 指南。

7. 状态说明

  • 有分层源码、三个独立包与自动测试。
  • 有 Windows 一键本地打包入口和多平台 CI 发布配方。
  • 有防覆盖保存、恢复队列、输入与布局回归测试。
  • 完整的真实中文输入法和跨设备验收。
  • 所有导出内容在目标阅读器的视觉验收。
  • MCP 与目标真实客户端的完整互通验收。
  • 按统一基准测量长文性能与原型还原度。
  • iOS、HarmonyOS 的可安装分发包。

下一篇:概要设计。

💬 评论暂未开启
有疑问或建议,欢迎到 GitHub 提交 Issue 参与讨论。
tems[selIndex] as HTMLAnchorElement).click(); } } });