「MOSS - 31」MOSS队：Beta阶段软件发布声明

「MOSS - 31」MOSS队：Beta阶段软件发布声明

项目	内容
这个作业属于哪个课程	2023年北航敏捷软件工程
这个作业的要求在哪里	团队项目-Beta阶段软件发布声明
我们在这个课程的目标是	熟悉敏捷开发的方法论，并通过实际开发产品进行实践。
这个作业在哪个具体方面帮助我实现目标	完成Beta阶段软件的发布。

Author: MOSS队

Date: 2023.06.03

Part 1 这一版本的新功能和特性

通知查询

为了让用户获得即时的反馈和更新、改善用户体验，我们设计并实现了通知查询功能。用户可以查询的通知分为两类：第一类是由管理员发布的全局通知。例如，当平台做出了功能或政策性调整时，管理员就会发布全局通知来将变化告知所有用户。第二类是由系统自动发布的点对点通知。当有辅导师在学生用户提出的问题下给出了新的回复时，系统会自动向提问者发出【issue回复通知】，以便用户及时获得解答和反馈，并和辅导师进行进一步的互动。

通知发布

只有管理员才有权限发布通知，管理员可以编辑通知标题和通知内容。

添加关联问题

为了避免对同质问题进行重复回答，辅导师可以给其负责的问题添加“关联问题”，这些问题可以是有着相似的解法和思想，也可以是有着类似的应用场景。这样可以方便同学们以这个问题为基点，快速了解这一问题的相关问题，从而对问题形成更深刻的理解。

修改问题标签

标签可以对问题在科目/章节二级结构之外，从另一个角度进行刻画和描述。例如作业题、考试题、debug、经验分享等。辅导师可以给问题添加标签，以便于同学们进行搜索。

这样做的好处是，可以对问题进行多维度的分类和描述，以便对已有的问题进行归纳和整理，方便学生根据自己需求进行搜索。

管理问题标签

辅导师只能从现有的标签中选择一些添加到问题上，而管理员可以建立新的标签或者删除已有的标签。

完善修改密码

考虑到用户输入新密码时可能会由于输入错误导致实际密码与想要输入的不符，我们添加了重复新密码的要求。此外，为了避免空密码和过长的密码，我们将密码长度限制在6~30位。

找回密码

若用户忘记了密码，可以通过找回密码功能，重新设置一个密码。输入学工号，点击发送验证码后，我们会向这个学工号对应的北航邮箱中发送一个验证码。用户在收到验证码后，可以使用该验证码重置其账户的密码。

该功能主要解决之前用户一旦忘记密码，就只能联系管理员手动重置密码的弊端。

热门问题和用户展示

在搜索页面，我们会展示当前的热门问题和活跃用户。这样做的目的是给激发大家提问和回答的热情，同时给反映当前普遍而热门的问题。

往届问题搜索

每学期都会有不一样的科目，都会新增一个学年来管理这些新的科目章节和问题。但以往的问题仍可能对现实有指导意义，因此有必要提供一个对往届问题的搜索功能。切换到“以往学期问题”后，可以选择历史学年，对之前学期的问题进行搜索。

搜索优化

alpha阶段时，用户必须选择科目和若干个章节后才能进行搜索。而在beta阶段，我们新增了默认全部搜索功能。具体地，若不选择学年，则默认对全部学年进行搜索；若选择学年而不选择科目，则默认对该学年下所有科目进行搜索；若选择学年和科目而不选择章节，则默认对该科目下所有章节进行搜索。这样的改进使得搜索更加用户友好，更符合一般人的使用习惯。

此外，我们也增加了模糊搜索功能。对于输入的关键字，我们会只能进行分词处理，大大增加了搜索的准确度。

更优越的md文本编辑器

beta阶段我们采用了更优越的文本编辑器，即mavon-editor，其具有

1. 丰富的工具栏：此编辑器具有一套支持各种Markdown语法的完整工具栏，例如粗体、斜体、引用、有序/无序列表、链接、图片等，方便用户直接点击按钮进行编辑而无需记住所有语法。
2. 代码高亮：mavon-editor支持代码高亮，包括多种编程语言和主题，改善代码的可读性。
3. 自定义样式和扩展：编辑器可以让开发者根据项目需求，轻松定制自己的样式和功能。
4. Markdown和HTML双重支持：允许用户在Markdown和HTML之间切换，便于在不熟悉Markdown语法的情况下进行编辑。
5. 更有对应的md语法提示，方便初学者使用

这是文本的对应展示效果

草稿的保存与复现功能

beta阶段我们加入了草稿的保存与复现功能。其使用场景为，学生在编写长段文本时，可能遇到临时情况而不得不转而做其他的事项，这时可以使用草稿的保存功能，下次发布问题时点击回复草稿便可以回复最新一次保存的草稿，十分方便实用。

统计图展示

我们需要掌握使用我们软件的用户的一些关键行为信息来分析软件的优势与不足，因此，一个直观反映用户关键行为信息的统计图系统就至关重要。

对于用户的一些关键行为信息，我们进行了数据统计，并且通过丰富的图表形式展示出来。不仅如此，我们还支持选择特定的时间区间。

我们支持的统计量包括：辅导师回答问题次数、辅导师复审问题次数、问题访问次数。目前支持的图表有两种：折线图和饼图。

对于折线图，横轴是选定的时间区间，纵轴是每日的统计量（例如：所有辅导师当日回答的问题数）。

对于饼图，我们将每种统计量分成五个区间：1~10次，11 ~ 20次，21 ~ 30次，31 ~ 40次，40次以上（例如：这段时间被访问1 ~ 10次的issue数量是18）。

志愿时长统计

为了便于“士疑解惑”活动组织者统计各位学生和辅导师的志愿时长，我们实现了志愿时长的自动统计。考虑到灵活指定志愿时长分配策略的需求，我们的前端支持管理员用户输入每个有效问题/回答问题/复审问题可以获得的志愿时长。同时，为了能够向学生和辅导师发布结果，我们也支持将结果导出为excel。

Part 2 这一版本修复的缺陷

使用更加友好的 markdown 编辑器

提问和回答功能为本平台的杀手级功能之一，而原先的编辑器仅支持 markdown 且无语法提示，代码高亮也支持较差，对于不熟悉 md 的大一新生并不友好。而新采用的编辑器同时支持 markdown 和 html，有 markdown 语法提示，工具栏更加丰富，代码高亮也支持较好，提升用户使用体验。

增加找回密码功能

原先忘记密码的用户只能联系管理员重置密码，增加了管理员不必要的工作负担、且用户可能不能得到及时反馈。在 BETA 版本我们增加了找回密码功能，通过向用户的北航邮箱发送验证码，允许用户重置密码，改善了用户使用体验。

优化搜索功能

在 ALPHA 阶段，用户欲搜索问题必须选择科目和若干章节，操作较为繁琐。BETA 阶段我们新增了默认全部搜索的设置，使搜索功能更符合大量用户的使用习惯。我们还增加了模糊搜索功能，对于输入的关键字进行分词处理，提升用户搜索效率。

增加草稿保存和恢复功能

提问和回答功能为本平台的杀手级功能之一，但用户在编写长段文本时，可能需要临时中断编辑并转而完成其他事务，稍后需要回到本界面继续编辑。ALPHA 阶段并不能满足用户这一需求，于是我们在 BETA 阶段加入了草稿保存与恢复功能，更加便利用户。

修改前端配色方案

在 ALPHA 阶段，我们的平台被多名用户指出配色方案不美观，多处具有对比度过强/过弱、色系不同一等问题。在 BETA 阶段我们调整了统一的配色方案，改善用户使用本系统时的心情。

新增全局通知和issue回复通知功能

在ALPHA阶段，我们的平台没有一个全局通知功能，管理员没能全局通知用户相关信息，在BETA阶段解决了这个问题。

在ALPHA阶段，我们的平台没有针对issue回复进行单个通知。学生并不知道自己提出的问题是否已经被辅导师认领并回答。在BETA阶段，我们针对issue的辅导师回复在平台层面给予issue提出者相关通知。

新增辅导师工作量统计功能

在ALPHA阶段，我们的平台没有提供管理员导出工作量统计的功能，在BETA阶段已经实现该功能，解决了手工统计工作量的问题。

新增学年功能

在ALPHA阶段，我们的平台没有提供“学年”系统，即所有的issue都是针对当前年份进行提出的。在BETA阶段更改了这个缺陷，新增学年系统能够实现过往问题不和当前学年的问题重复，实现平台的可持续使用。

Part 2 对运行环境的要求

本平台 BETA 阶段实现 Web 端应用。经过兼容性测试，用户可以在 Windows 、MacOS、Ubuntu 这三类主流操作系统，使用浏览器（Firefox ≥ 100，Chrome ≥ 100，Edge ≥ 100，Safari ≥ 16）登录网站并正常使用全部功能。

Part 3 使用方法

访问ShieAsk

本软件为网页平台，无需安装，直接访问士问士答即可。

注册方式：由辅导员批量导入账户，初始账号和密码均为学号。

使用说明

登录账号已提前导入，暂不支持个人注册

第一行输入学号，第二行输入密码（每个账户都具有默认密码，请及时登录更改密码）第三行输入4位验证码（字母不区分大小写）即可登录

如果忘记密码，可点击右下角按钮，通过邮箱验证重置密码

导航栏

左侧共有两个选项栏。点击上面的按钮，进入个人信息页面。点击下面的按钮，进入搜索页面。右侧点击头像右边的下拉箭头，可以看到我的信息、我的通知和退出选项。

个人信息页面

在个人信息页面中，可以定制自己的信息，设置头像修改密码等。初次登录后，建议修改默认密码

面向学生

登陆后，默认进入搜索界面

如何搜索

推荐在提问前，先通过搜索功能查找有无相似问题。可以添加搜索条件，对已有问题进行条件搜索。

• **学期选择：**右上角有一个开关，表示是否选择查询以往学期的问题。

• 关键词栏：搜索结果的标题中将包含该关键词。若为空，则表明不限制关键词。

• 排序方式

  ：共支持四种排序方式，默认最近优先。

  • 最近优先：按照问题的发布时间排序，越晚发布的问题顺序越靠前。
  • 最早优先：按照问题的发布时间排序，越早发布的问题顺序越靠前。
  • 最热优先：按照问题的热度排序，点赞和收藏数越高的问题顺序越靠前。
  • 综合排序：随机推荐符合条件的问题。

• 科目章节：选择问题所属的科目。选定科目后，还需选择问题所属的章节。科目只能单选，章节支持多选。

• 热门列表和活跃用户：可以查看当前的热搜问题和活跃用户。

如何提问

点击“发布问题”，可以打开问题发布弹窗。

在最下方选择问题的所属科目章节，以便相应的辅导师来认领。

在最上方填写标题，尽可能精简地描述您的问题。在标题中可以不再包含科目和章节已包含的信息。

在中间的问题描述部分，尽可能详细地描述您的问题。可以上传本地图片，直接将本地图片复制粘贴到问题描述的文本框中即可实现上传。

在右下角可以选择是否匿名提问，若选择匿名提问，其他学生和辅导师将无法看见提问者的个人信息。

个人主页

学生在个人主页可以分别看到自己提出的问题、收藏的问题。按照最近一次的更新时间排序，越近越靠前。

如何与辅导师进行交互

对于学生用户，搜索界面只会展示已解决的问题。因此当您提出一个问题后，可以在个人信息页面-提出的问题处找到您题的问题，点击查看即可进入详细页面。

在题目详细页面，可以看到问题的标题、描述和状态。刚提出的问题默认为未被辅导师认领的状态。

若想修改问题的标题、描述等信息，可以点击编辑按钮进行修改。

若在提问后发现问题已经自行解决，无需再麻烦辅导师来回答。可以点击关闭按钮，关闭该问题。

辅导师认领后，可以在对话框内和辅导师进行交流，对话流以时间线的形式整理

交流结束后，根据对辅导师回答满意与否，您可以选择拒绝辅导师回答或者同意辅导师回答。

• 若同意辅导师回答，问题将进入复审环节，交由其他辅导师来检验回答是否准确无误。
• 若复审的辅导师发现之前辅导师的回答有误，会重新打开该问题，进行补充回答。在补充回答后，您可以再次选择拒绝辅导师回答或者同意辅导师回答。若拒绝回答，系统将重新分配其他辅导师进行回答。

小tips：若辅导师回答了issue，则会通过平台发送通知，请及时在我的通知中查看

面向辅导师

比学生多了一个问题状态的选项，可以筛选指定状态的问题进行搜索

辅导师可以认领其对应科目的问题，认领后方可在问题下进行回答。

认领后，若辅导师认为提问者的问题有不准确的地方，可以对问题进行编辑修改，以完善问题描述。

提问者在问题得到解答后，会点击同意辅导师的回答。同意后，提问者和辅导师将无法再在该问题下发言，该问题将会转为待认领复审状态。

若提问者认为该辅导师无法继续解答问题，会点击拒绝辅导师的回答。点击后，该辅导师将不再负责回答该问题，该问题会重新回到未认领状态，等待其他辅导师认领。

辅导师页可以对其他辅导师已经回答过的问题认领复审。辅导师无法认领复审自己回答的问题。

认领复审后，辅导师需检查该问题和回答是否准确无误。

• 若辅导师认为该问题下的回答有误，可以选择重新认领。重新认领后，复审的辅导师会负责重新回答该问题，纠正之前的错误。
• 若辅导师认为该问题下的回答准确无误，则需要根据该问题是否对其他学生具有参考学习的价值，将该问题分为有效和无效两类问题。非提问者的学生只能看到有效问题。

在个人主页，辅导师可以看到自己回答、复审和收藏的问题列表。

Part 4 描述系统已知的问题和限制

1. 描述系统已知的问题和限制

   软件目前存在的问题：

   • 仅在用户登出时实现了注销jwt的操作，没有对浏览器直接关闭等情况设计注销jwt的机制。
   • 与alpha阶段类似，服务器能承受的并发量仍然有限，无法应对部分极端的并发情况。
   • 辅导师目前没有特别方便的修改自身回答的渠道，可能需要联系数据库管理员。
   • tag可以由辅导师自由添加，可能会产生同义tag的冗余。

   软件目前存在的限制：

   • 目前只实现了网页端功能，暂时不支持小程序和app的实现。
   • 与alpha阶段类似，图像目前存储在服务器端中，用户量增大时可能会有存储空间不足的问题。
   • 管理员只能从通知功能发布全局的通知，暂时无法对其中一部分同学发布通知。
   • 志愿时长的换算目前只支持线性的换算，不支持自定义公式。

Part 5 说明软件的发布方式以及发布地址

浏览器直接访问士问士答（ShieAsk）即可。