PublicFiles

本仓库用于存储源代码和各类文档，发布规范参考信息，方便协作。

2020.11.24更新

重要事项

近期Deadline:


近期重点任务:

开会流程

0. 会前发送agenda和房间位置在群中, 正式会议记得还有heshan版本
1. 回顾报告上周工作

• 确认主持人和秘书, 以及会议时间
• 报告已完成工作
• 待完成issues确认
• 确认未完成工作

2. 本周任务讨论

• 讨论本周待完成任务
• 分配任务和人员

3. 下周事务安排

• 确认主持人和秘书

4. 项目总览

• Gantt 及 timeline回顾更新

5. 会后事项

• 主持人更新timeline中该周工作, 记录遇到的问题, 总结反思
• 主持人发送该周完成的任务给heshan (图片和文字)
• 秘书更新issues, 分配给相应人员
• 秘书整理好任务在群里也发一份, 名字-任务
• 主持人和秘书根据需求定下周的房间
• csl 更新gantt

邮箱

方便抄送用

Dr. Heshan [email protected]

Ruizi Han (20125115) [email protected]

Shiliang Chen (20125016) [email protected]

Yani Huang (20125915) [email protected]

Yijie Lu (20125931) [email protected]

Yiming Tang(20126870) [email protected]

Yuting Jiang (20126307) [email protected]

如何发送邮件可以再制定。暂定：收件人 Dr. Heshan，抄送所有其他人。

Division of labour

• Team Leader: Shiliang Chen

• UI Designer: Yiming Tang, Yani Huang

• Technical Leader: Shiliang Chen

• Quality Assurance Leader: Yijie Lu, Yuting Jiang

• Report Editor: Yani Huang, Yuting Jiang ,Ruizi Han

• Repository Master: Ruizi Han, Yiming Tang

• Monitor (Tester): Yani Huang, Shiliang Chen

语言规范

中文(CN)：规范使用中国大陆官方简体中文

英文(GB)：规范使用英国英文

Commit 规范

<type>(<scope>): <subject>

其中type以及subject为必须要的部分，请注意冒号后的空格，实际使用时不需要"<>", 例如：

docs(README): fix grammar

fix(Main): fix function call

type

用于说明commit的类别，有以下七种

• feat: 新功能，代指feature

• fix: 修补问题bug

• docs: 文档类，如更新readme，模板，会议记录等

• style: 仅改变格式，没有其他影响

• refactor: 重构，不新增，也并非是修改bug

• test: 增加测试

• chore: 构建过程或辅助工具的变动

scope（可以省略）

用于说明 commit 影响的范围（暂未清晰）

• 可以是Java 某个类等

subject

简单描述具体做了什么

• 动词开头，第一人称单数一般现在时，如add，change
• 首字母小写
• 不加句号

注释规范

注释规范分为文档注释，测试注释。因为暂未选定语言，因此注释规范暂定

代码规范

由于暂未选定语言，因此代码规范暂定

Change log规范

change log包括三个部分，对应了commit的内容，在每次新版本发布时需要

• New features
• Bug fixes
• Breaking changes

会议记录

本文件夹存放会议记录文件，以 .md 文件保存。

Markdown 格式简洁美观，导出 PDF 容易，方便记录。

文件名规范

模版 (Template)

模版单独放在Template文件夹中，因为以后可能需要修改。

中文模板：模板_最后修改人缩写_时间_版本.md

如：模板_TYM_1014_v1.md

英文模板：Template_name_time_version.md

如：Template_TYM_0930_v1.md

在使用时，取版本号最新的模版。

会议记录

中文： 次数_时间_是否正式_主持人缩写记录人缩写_版本.md

如：3_0930_否_CSLHRZ_Final.md,

英文： No._Time_WhetherFormal_names_Version.md

如： 5_1014_T_TYMJYT_Final.md

• 是否正式：是否有 Supervisor 参与。是的话填T/是，否的话填F/否。
• 版本：由于会议记录有三个流程（Chairperson 写 Agenda (A)、Sec 写Minutes (M)、Chairperson 写 Comments），请将每个上传到本仓库的会议记录标记版本（A (Agenda)、M (Minutes)、Final），方便之后整理。A和M非必须上传，Final版本必须上传。
• 语言：CN（中文）和GB（英文）。

竞标文件

已完成

Documents

本文件夹存放未分类的实用文件或暂时无法分类的文件。存放的文件请在此处大致表明原用途。

• Agenda_and_Minutes_templates：Dr. Heshan 给的相关模版
• AE2GRP_Group05_GroupReport.pdf：Dr. Heshan 给的1617相关项目的report
• AE2GRP_Group05：Dr. Heshan 给的1617相关项目

Others

本文件夹存放已无用但仍暂时保留的文件。存放的文件请在此处大致表明原用途。

• Project_16：搜索到的以前其他组做过的P16的源代码。

Src

本文件夹存放源代码。格式之后再讨论。

项目时间线

9/30

第一次informal meeting， 开始分配工作，互相了解小组成员，选择项目写bid

10/4

第二次informal meeting，澄清bid相关事宜，优化，初版分享

10/6

第三次informal meeting，bid审核，cv审核，准备提交

10/8

中标20，准备相关工作，开始项目

10/10

第四次informal meeting，准备第一次formal meeting相关问题

10/15

第一次formal meeting，介绍小组成员，初步讨论项目规划以及需求

10/20

第五次informal meeting，谈论了有关网站，ethics，requirements的事项，确认了目标人群，确定了问卷和访谈的市场调研方法

10/21

完成初版ethics form，初版survey，初版consent form

10/22

第二次formal meeting，询问了有关correctness的问题，澄清了有关requirement的要求，审批了初版survey，确定了ethics form

10/23

发送了ethics form的邮件

10/24

周报: 1.近阶段大家可以开始学习起来latex 2.礼拜二开会前大家想一下correctness的实现方案礼拜四要汇报确认的 3.搜集或者制作我们app有可能的不同风格界面用在问卷给user选 4.想一想采访老师的问题

10/27

第六次informal meeting, 讨论了关于survey的细节和correctness的两种实现方案，准备写成文档在下次meeting的时候向heshan确认。确认了website的内容，已上线。想了几个功能，打算survey中向用户确认。有了interview的基本问题，需要明天向dave确认上交问题和问卷以什么形式附上。

10/28

第三次formal meeting，确认了网站，确认了survey，确认了interview 的几个问题，确认了correctness一步步来，确认了requirement根据ppt写 下阶段literature review以及准备期中报告，继续准备问卷和采访，注意要对我们产品有所帮助

11/3 晨会讨论了各个ethics form的最后确认 下午制作了最后的版本，并且邮件给了heshan 第七次informal meeting，讨论了literature review 相关内容，分配了相关工作，然后讨论了focus group的安排，最后反馈了时间线的问题，并且提了一下需求的日程 确认了literature review的格式，确认了文献摘录的来源并且确认了人员分配。检查了timeliness，确认了UML的运用。确认了focus group和interview的人员

11/4 上传了ethics 附加的几个内容

11/5

• 会议开始的时候上次的主持人来review，增加连贯性
• literature 初版paragraph ddl定在2020/11/09 周一
• Focus group的问题将在2020/11/06~2020/11/07间进一步的确定
• Requirement的各项工作（包括Focus group、调查问卷、对老师的interview）及结果分析预计将在Dave审批结束后4~5天内结束

11/6 周报：

1. 大家还是趁着空闲时间学一下LaTex 比如用它来写我们的literature review
2. literature review，我们的ddl定在了礼拜一之前，大家记得在礼拜一之前完成之后交付给yijie
3. Yani负责的大一大二的focus group即将在明天进行，一定会顺利的！
4. 我们的问卷调查应该是可以进行了，等明天的focus group结果出来后应该可以继续安排问卷了
5. 还有一组大三的focus group可能要到下周工作日进行
6. 礼拜二之前要准备好我们的几个小prototype，有想法的人准备用来给大家演示
7. 下次的主持人是yiming，秘书是yijie，上阶段工作总结员是yani

11/7 下午进行了大一与大二的focus group 准备大三的

11/10

开会，感觉到了废弃游戏也许heshan会不愿意，然后分了工。

问卷分析、focus group分析、原型、采访等。

11/11

关于近期： 学姐说LR也好，requirements的document也好都是后期可以加的附加点，主要要把迭代做好，指导老师可能不是很懂，要去参考参考dave组的进度，或者我们去找dave聊一聊我们的时间安排，不管是迭代还是test，都要表现出来显得我们的process非常的完善，pre中会需要介绍到process，demo openday中要呈现完善的成果，基本功能一定要先完善好，一步步迭代到后期的创新，因为code会被看到，所以要有好的documentation，interim report用来追踪进度，final report会被dave看到，打分是各个老师在打，所以要让不懂得老师也能觉得我们做的东西很有用（我们可以现在就去找hengyu了解一下他的期待或者事先打预防针让他给我们打高分

相关工具：teambition, trello, notion, tower.im, mendelay,还有学姐发布的template

11/12

Formal meeting:

• 向heshan汇报了目前requirement gathering的部分结果，问卷报告和focus group报告。
• 询问了软件设计方向的问题，heshan认为偏向游戏或功能，这两者不冲突。但同意我们废弃奖励机制的想法。
• 汇报了下之后会做的事情，interview和focus group，以及requirement gathering之后的事情。

11/17

• 改进了requirement，但是correctness部分的功能还需要完善。
• technical research的方向还需要讨论和敲定。
• Dave建议最晚11月末要开始coding。

近期任务：

• 确定requirement，完成functional和non-functional文件
• Questionnaire report
• UML diagrams
• Extend description of problem
• risk management

11/25

本次会议进程并不顺利，主要问题是会议主题是汇报工作和对汇报项的讨论和再分配 但是进度并不顺利，分配的任务没有得到很好地完成 陈诗量和黄雅妮的use case进度停滞了，因为没有问bgl 唐懿明的需求文档没有修改 卢艺捷的literature review任务看错了 所有人technical research的进度都不好

原因以下： 会前没有说预计时间 DMS课业负担过重 教室空调温度过高 会议讨论向会比较合适 进度或许需要在会议前与大家跟进 会议主持人可以在会后一定时间段进行任务督促

1/7 继续学习react, 汇总了一些学习资源

1/8

完善设计细节,讨论了procedure页面的分页面跳转方式

1/9

继续完善细节

1/13

完成了井字棋的注释工作, 顺便学习了react的更多难点和细节

准备下一阶段, 因此开始了完成井字棋附加任务的任务

1/20

分组做了三个组件及其测试

1/27

分两组分别做了UI和动画

2/3

已完成任务总结：

1. 完成了基础UI设计
2. 完成了部分算法动画
3. 完成了test plan 和 test log
4. 为final report 做准备

遇到的问题：

1. 注释和测试格式不规范 解决方法：用documentation模板和testLog模板统一规范
2. 整体进度比计划慢

解决方法：目前未解决

2/10 已完成任务总结：

1. 完成了correctness的prototype设计
2. 完成了correctness的基础页面制作
3. 完成了heap sort 和quick sort
4. 完成了几个branch的整合, 将算法和页面结合了起来
5. 完成了三个基础算法的introduction部分trace的书写
6. 修复了image传入路径读取失败的问题
7. 修复了theme无法被读取导致button颜色不正确显示的问题
8. 正在进行help页面的精修
9. 正在进行correctness的下一步
10. 正在进行quick sort的优化
11. 正在进行merge sort
12. 正在进行JsxDoc的书写
13. 正在进行final report的计划
14. 正在进行各页面文案的搜集查找
15. 正在进行sorting algorithm的测试

遇到的问题:

1. 会议主持未事先准备
   • 延迟一小时开会, 如开会者不方便则由其他人代为准备
   • 在前一个礼拜要确定好下次会议的时间, 大家达成共识
2. issue没有及时清理
   • 通知大家及时完成任务后进行清理工作
   • 通知有bug及时issue
3. 整体进度比计划慢
   • 及时跟进进度报告

2/17 已完成任务总结：

1. 完成了final report的大致计划，下次会议发布任务。
2. 正在进行上阶段工作的完善。

遇到的问题：

1. 会议主持在开会前没有想好部分需要讨论问题的可能的方案，因此浪费了很多时间。
   • 提前思考一下，给大家一些可能的方案，缩短思考时间。
2. 会议主持不够果断，某些问题纠结了很长时间，会议不够有效率。
   • 在这种情况下，会议主持可能需要成为那个做决定的人。

2/22 已完成任务总结：

1. 进行了部分上阶段完善工作，与heshan进行了软件洽谈，得到了些许意见
2. feedback总结了一下，等待完善期中报告

遇到的问题：

1. 会议中个人发言任务没有落实到个人，导致知晓任务迟了
2. dave商讨任务暂定

2/23 已完成任务总结：

1. 讨论了昨天formal meeting老师提出的问题，并分配了任务。
2. 确定了correctness页面的详细设计并分配了任务。

遇到的问题：

1. final report暂时搁置了

3/1 已完成任务总结：

1. 更新了requirement，所有的剩余requirement都在计划中
2. 开始设计Tutorial

遇到的问题：

1. Correctness Tutorial 的部分设计heshan并不满意，需要修改

3/12

已完成任务总结：

1. 更新了requirement，uml
2. tutroial 除了terminology部分都完成了
3. correctness的tutorial还差两个图文部分
4. procedure的图标问题基本解决

遇到的问题：

1. 会议中有讨论未完成事项的可能影响会议进程和效率
2. 会议记录整理速度较慢可能导致任务忘记,分配不及时导致晚交迟交
3. 任务在周中未提醒导致有最后一天才发现有这个任务
4. issue们越积越多,refactor任务不重视,积攒过多,documentation质量不佳
5. 及早进行report,分批次给heshan看
6. ddl定下不能拖了,给出实际时间

3/19

已完成任务总结：

1. 增加了页面过渡动画
2. correctness的tutorial完成
3. tutorial 和 correctness 图标完成
4. 三个recording脚本框架基本完成

遇到的问题：

1. 每周的工作不能全部按时完成，影响整体进度
2. 分配工作花费的时间较多
3. report进展缓慢

3/22

已完成的任务总结：

1. Tutorial的terminology 页面已经完成
2. 流畅页面切换的动画已完成
3. 图标动图和软件icon基本完成

遇到的问题：

1. 结束阶段任务繁重
2. report时间紧迫