nex_docus/docs/sdd/specs/DV-0003-document-editing/spec.md

1.0 KiB
Raw Blame History

DV-0003:文档编辑与文件操作 – 规格(Spec)

  • 状态:Implemented
  • 关联 ADR:ADR-0002

目标

提供无限层级目录树与完整的 Markdown 文档编辑/文件操作能力。

范围

  • In:目录树、读/存文件、新建/重命名/删除/移动、上传图片/文档、导入/导出、导出 PDF。
  • Out:富文本编辑器(仅 Markdown)。

用户故事

作为文档作者,我希望编辑 Markdown 并管理目录结构,以便维护有序的知识库。

功能需求(FR)

ID 需求 验收要点
FR-4 目录树 + 文件操作 + 上传/导入/导出 无限层级;目录在前名称排序;_assets 不展示
FR-4a 前端编辑器 + 保存 Cmd+S 保存;图片/附件上传

非功能需求(NFR)

ID 需求
NFR-3 路径安全(所有文件操作复用 get_secure_path)
NFR-5 aiofiles 异步 I/O;PDF/长文档虚拟滚动

边界与约束

  • 隐藏文件不进入树;_assets 不进入树。