团队作业2——需求分析&原型设计
一.初步需求
-
统计代码量,按编程语言分类,统计各个语言分类下的代码数量
-
按程序中的函数和类进行代码统计数量
-
使用一键即可重命名函数名、类名
-
查找重复函数
以上是题目中本来需要完成的功能,经过与助教的讨论后,助教为我们提出了意见。
希望我们能先调查一下市面上的类似工具,再决定我们要去做的程度,我们的设计是否只针对某类些语言(毕竟许多语言都是互通的),还是说我们想做通用的基础的方向。
需求分析文档
https://coding.net/u/hts-technology/p/CodeManagement/git
二.需求分析
a、NABCD
N (Need):现在随着学生编程量的加大,相应老师所需要审查的代码量也慢慢变多,为了提高老师的效率,同时又不降低质量,但同学想检查自己的代码是否过于繁琐时又无从下手,当想提高代码的利用率时,又无法直观的显示。
A (Approach):我们小组打算通过Web前端+后台数据库的方式来达到用户只需提交代码,而其他由程序解决。
B (Benefit):能大大提供老师批改代码类作业的效率,同时查重功能也能从很大程度上减少抄袭现象。让同学检查自己的代码是否重复太多过于冗余,精简代码。
C (Competitor):目前学校内该类型的竞争对手基本没有,可以说市场是有非常好的前景的。
D (Delivery):先交由老师与助教进行使用测试,效果显著,自会有老师为我们进行推广。
b、电梯演说
我们的代码分析管理系统是为了解决 许多老师和学生的痛苦, 对于他们需要了解学生编写的代码是否正确,其中有多少是学生独立完成,又有多少是抄袭得来 ,但是随着学生基数的加大也大大加重了老师在批改作业方面的负担,对于学生他们需要了解自己所写的代码包含了那些冗余的功能如何加以修改,使之更为精简。但是现有的方案并没有很好地解决这些需求,我们有独特的办法 通过我们的代码分析管理系统,它能给用户带来好处 满足老师与学生的需求,远远超过目前市场上的竞争对手 。 同时,我们通过老师使用后进行推荐,能很快地让大部分用户知道我们的产品,并进一步传播。
三.原型设计
用户登录界面:
用户注册界面:
用户使用界面:
四.编码规范
- 我们代码风格的原则是:简明,易读,无二义性。 在变量命名时要首先一表明功能作用为主,不滥用如 i,j,k之类。
- 尽量做到多句代码不写在同一行,对于嵌套之类的语句做好每个子语句缩进处理,使得阅读更直观。
- 内部默认某些命名顺序,做到不重复使用。