联系方式

  • QQ:99515681
  • 邮箱:99515681@qq.com
  • 工作时间:8:00-23:00
  • 微信:codinghelp

您当前位置:首页 >> Java编程Java编程

日期:2020-10-24 10:37

Design Document Criteria

CSSE2310: Computer Systems Principles and Programming

Semester 2, 2020

Contents

1 Mark Breakdown 2

2 Presentation Marks 2

2.1 Readability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2.2 Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

3 Content Marks 3

4 Mark Disqualifiers 4

5 Marked Examples 5

5.1 No Mark Awarded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

5.2 Mark Awarded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

6 General Feedback & Notes From A Marker 6

1

Design Document Criteria CSSE2310

1 Mark Breakdown

Minimum: 0

Maximum: 7

Presentation: -2

Content: 7

Document content will be positively marked out of 7. For poor presentation, a maximum

of 2 marks will be deducted (that is, students can receive -2, -1 or 0).

2 Presentation Marks

2.1 Readability

Readability refers to grammar, spelling and use of paragraphs.

2.2 Presentation

Presentation refers to the document’s formatting and professional. Students who go over

the page limit will receive -2 for presentation.

Page 2

Design Document Criteria CSSE2310

3 Content Marks

Students will receive at most one mark per dot point addressed. That is, to receive 7

marks, you must discuss 7 dot points. Please note, marks will be awarded to areas that

are not limited to the below list.

For each dot point students must say: What they did, if it was good/bad and why

it was good/bad.

? Overall program design

? Use of data structures

? Use of enums

? General style guide (e.g. magic numbers)

? Functional decomposition

? What they would have done differently (in contrast to what they did)

? Program flow (e.g. 1. Set up 2. Read files 3. Played game 4. Cleaned up)

? Repeated code, including if they had repeated code or what they did to avoid

repeated code

? File handling

? Error handling

.

Marks will be awarded to students not based on if they handled files (as an example)

correctly, but on how they reflected on how their file handling. A student with poorly

styled code and anti-patterns1

can receive just as many marks as a student with well

styled code if they explained why it was a poor implementation.

The reader (and marker) is well versed with the your assignment and code. Therefore,

do not waste valuable space quoting the spec or code, unless, it aids your design

decision justification. You are marked on demonstrating the reason on why you wrote

your code the way you did, not just summarising what you wrote.

1Anti-patterns are design decisions in code that are generally regarded as poor design. For example,

a single struct that contains all information about a program.

Page 3

Design Document Criteria CSSE2310

4 Mark Disqualifiers

Mark disqualifiers will be given to students who provide incomprehensible reasoning or

contained contradictions. Below is a list of common reasons, but not limiting to, why

students may recieve mark disqualifiers.

? What is described in the document does not match their code.

? Explanations are incomprehensible to the point of no meaning or contained significant

errors.

? Student contradicted themselves.

? Statements had limited or incorrect justification

Regarding contradiction, this relates to a student stating one thing, however later stating

a contradicting statement. For example, the first paragraph outlines that they have good

functional decomposition as each function did only one thing. Within the second paragraph,

the student then states that they had one function which handled the file reading,

game handling and error handling.

Regarding limited justification, this relates to students stating what they did, but not

why or what benefit it brought. For example, the student states they used structs but

did not state why they used structs. Please refer to Section 5.1 for further explanation

and worked examples.

Page 4

Design Document Criteria CSSE2310

5 Marked Examples

5.1 No Mark Awarded

I used stucts in my assignment. I passed my struct to functions by pointers. Before the

assignment, I did not understand structs, but now I do. My game struct had two ints to

keep track of the board’s height and width. It also stored the board as a 2 dimensional

array. This 2D array’s memory was dynamically allocated.

.

Reasoning for No Mark Awarded

The above example mentions they used structs but showed no reflection. That is, it just

verbally describes their code. The above example does not mention why they used the

struct, the purpose of the struct or if their usage was good or bad.

5.2 Mark Awarded

I used stucts well throughout my assignment, for example my Board struct contained

only and all information relating to the board. This allowed me to pass only one variable

around (an instance of my board struct) to functions, rather than 6 separate variables.

This allowed my code to be readable. Additionally, because I used a board struct, it

allowed me to organise my information to ensure that all relevant information was being

passed.

.

Reasoning for Mark Awarded

The above example mentions they used structs, but more importantly explained why

they used structs and why it is was good.

Note: These are hypothetical examples written by tutors. These are not actual student

submissions.

Page 5

Design Document Criteria CSSE2310

6 General Feedback & Notes From A Marker

? Students often receive low content marks as they state what their code was doing

but showed no reflection or reasoning behind their design decisions. Please ensure

to always write your reasoning.

? The example design document contains example headers. However, these headings

may not be relevant to your code. Please ensure to choose the headings that are

most relevant to you and your assignment.

? A student can receive at most one mark for each dot point outlined in Section 3.

Regardless of how much or little they say about that topic. Therefore, please make

sure to address multiple aspects of your program.

? To give yourself a better chance of receiving marks, I would advise talking about 8

topics with sufficient justification. This gives you a buffer in case one topic discussed

does not meet the criteria.

? Students may include a snippet of their code, for example a struct or a function.

This is unnecessary to receive full marks. Markers will first read your code and

then immediately read your design document. As seen in example in Section 5.2,

it mentioned they had Board struct that contained information about the board.

This is sufficient. Whilst saying it is unnecessary, we do not discourage (or put a

blanket “no code snippet” rule in place), just consider how the code snippet will

aid in your justification, or is it a waste of space?

Page 6


版权所有:留学生编程辅导网 2018 All Rights Reserved 联系方式:QQ:99515681 电子信箱:99515681@qq.com
免责声明:本站部分内容从网络整理而来,只供参考!如有版权问题可联系本站删除。