[T.5]团队项目：功能规格说明书

[T.5]团队项目：功能规格说明书

项目	内容
这个作业属于哪个课程	2025年春季软件工程(罗杰、任健)
这个作业的要求在哪里	[T.5]团队项目：功能规格说明书
团队在这个课程的目标是	实践敏捷软工项目、在做中学中精进软件开发技术
这个作业在哪个具体方面帮助我实现目标	明确软件功能规格，确定核心功能，帮助团队在Alpha阶段明确目标

一、相关概念说明

概念	解释
本项目/本软件/本平台/JieNote	均指代在线文献学习平台JieNote
学生	覆盖从本科生到硕博士
科研工作者	特指在研究所/高校从事研究工作的科研人员
老师	特指在高校任教的有科研任务的老师
用户	对学生、科研工作者、老师的统称
文献	指学术文章、学术期刊等用户上传的文件
组织所有者	组织中具有最高权限的所有者，权限说明见组织管理部分
组织管理员	组织中具有次高权限的管理员，权限说明见组织管理部分
普通组织成员	组织中具有最低权限的用户，权限说明见组织管理部分

二、典型用户与对应的应用场景

​ 本项目面向的典型用户为：参与科研工作的学生、科研工作者、老师，在参与科研工作的过程中，一个典型的场景为“读文献+记笔记”, 即阅读学术文献、记笔记。本项目为用户提供了文献管理、文献标注、记笔记、笔记管理等一站式解决方案，用户的使用流程可以使用如下流程图解释：

典型用户	用户特征	应用场景
学生	有日常学习任务的同时具有一定的科研需求	在日常学习生活中阅读电子教材并记录学习笔记，完成科研任务时阅读文献并记录阅读笔记
科研工作者	主业为科研工作，如在研究所/大学进行研究工作	个人阅读文献并记录笔记，建立实验室的文献库和笔记库，方便实验室中的学生进行文献和笔记分享
老师	在日常教学之外，主要进行科研工作	与科研工作者应用场景大致相同

三、产品功能描述

3.1 产品功能图

​ 本项目的产品功能描述如下图：

​ 功能的优先级分为三个层次：

• 红色：本项目的核心功能，需要在alpha阶段完成
• 黄色：本项目的其他基本功能，需要在beta阶段完成
• 绿色：一些优化功能，酌情考虑完成

3.2 产品功能描述

用户系统

• 用户登录/登出：用户名/邮箱+密码登录
• 用户注册/注销：通过邮箱+验证码注册
• 基本信息管理：
  • 昵称/头像
  • 邮箱
  • 修改密码
• 我的组织
  • 申请加入/退出组织
  • 新建组织

笔记记录

• 提供markdown语法支持
• 提供latex语法公式编译
• 提供图片插入

笔记管理

• 笔记分类

  • 按照文章分类：依据文献分类结构建立笔记分类树状图
    • TODO：依据生成的树状图为用户生成一篇综述文章
  • 按照知识点分类：建立知识图谱

• 新建笔记

• 删除笔记：这里需要将用户删除的笔记移入笔记回收站，保留30天，防止误删

• 笔记批量导出：将用户选中的分类的笔记打包导出为压缩包，压缩包命名为笔记分类名

• 笔记批量导入：将用户本地上传的压缩包或文档导入到本在线平台中，用户需要指定导入到的笔记分类

  • TODO: 这里需要注意支持的导入文档格式：基本的支持如.md、.doc

• 对笔记进行log：参考git commit log，为用户记录用户记笔记的时间节点、相关内容等，呈现形式参考git log --graph

  这里考虑可以让用户每次记笔记写一个commit log

文献管理

• 上传文献：仅支持用户本地上传文献
  • TODO：建立文献资源库，使用户可以在线导入需要的文献
• 文献分类：参考Zotero等成熟文献管理软件的文献分类
  • 新建分类
  • 删除文献/分类：删除文献/分类将文献/分类移入文献回收站，分类需要保留原分类结构
  • 导入分类：从本地上传文献压缩包，将导入压缩包中全部文献并建立以压缩包名字命名的分类
  • 导出分类：导出某个分类中的全部文献为压缩包，压缩包命名为分类名
• 文献批注：
  • 支持文献划线高亮
  • TODO：对文献进行文字批注

组织管理

• 管理组织文库：

  • 删除文献/文献分类：组织成员可以申请删除文献，需要管理员审批
    • 被删除的文献被移入组织文献回收站中
  • 上传文献/文献分类：组织成员可以直接上传文献而无需审批
  • 其他基本文献管理功能与前述相同

• 管理组织笔记库：

  • 删除笔记/笔记分类：组织成员可以申请删除笔记，需要管理员审批
    • 被删除的笔记移入组织笔记回收站中
  • 上传笔记/笔记分类：组织成员可以直接上传笔记而无需审批
  • 其他基本笔记管理功能与前述相同

• 组织架构管理：

  • 组织所有者：具有最高权限

    • 新建笔记(分类)/文献(分类)
    • 删除笔记(分类)/文献(分类)
    • 批准普通组织成员删除笔记/文献
    • 为普通组织成员分配文献/笔记的只读/可编辑权限
      • 自身对所有笔记/文献有查看/可编辑权限
    • 管理普通组织成员：准入/移除
    • 管理组织管理员：授予管理员权限/收回管理员权限

  • 组织管理者：具有次高权限

    • 新建笔记(分类)/文献(分类)
    • 删除笔记(分类)/文献(分类)
    • 批准普通组织成员删除笔记/文献
    • 为普通组织成员分配文献/笔记的只读/可编辑权限
      • 自身对所有笔记/文献有查看/可编辑权限
    • 管理普通组织成员：准入/移除

  • 普通组织成员：具有普通权限

    • 新建笔记(分类)/文献(分类)

    • 删除笔记(分类)/文献(分类)(需要组织所有者/组织管理员审批)

    • 阅读/编辑自己具有权限的文献/笔记

四、页面原型设计

这里只提供大致草图

4.1 用户页面

4.2 文献与笔记页面

4.3 文献阅读/笔记整理页面

4.4 组织管理页面

4.5 组织页面

五、Alpha阶段项目验收标准

​ 本项目的Alpha阶段项目验收标准为：完成3.1产品功能图中标记为红色的功能，从功能上说，应当完成包括(以下均不考虑绿色功能)：

• 笔记记录功能的全部功能
• 笔记管理中除了批量导出/批量导入的功能
• 文献管理中除了导入分类/导出分类的功能
• 用户系统中注册/登录/维护个人信息的功能

六、Beta阶段项目验收标准

​ 本项目的Beta阶段项目验收标准为：在Alpha阶段的基础上完成3.1产品功能图中标记为黄色的功能，并尽力完成标记为绿色的优化功能，具体来说新增功能为：

• 笔记管理中中的批量导出/批量导入的功能
• 文献管理中中的导入分类/导出分类的功能
• 组织管理的全部功能
• 用户系统中“我的系统“相关功能
• 尽力完成绿色功能