|
Scorecard Details:
|
|
ID
|
Scorecard Name
|
Project Type
|
Category
|
Type
|
Min. Score
|
Max. Score
|
Status
|
|
30000320
|
Component Development Review Scorecard
v
2.4
|
Component
|
Development
|
Review
|
75.0
|
100.0
|
Active
|
|
|
Group:
Component Development
|
Weight
25.0
|
|
Section:
Component Development
|
Weight:100.0
|
Question 1.1.1
The implementation addresses the functionality as detailed in the
component design documents.
Question 1.1.1
The implementation addresses the functionality as detailed in the
component design documents. The reviewer should check
whether and how well all the functionality outlined in the design is
implemented. Each method should be implemented based on the provided
documentation. The functionality of the component as a whole should be
implemented as it was described in the documentation. Where applicable,
list the missing elements below.
Rating 1 - The implementation misses items included in the design
documentation, and as a result, the required functionality is no longer
provided, or the component simply does not work. A missing method
implementation should fall in this category, if the method is
reasonably important. If one or two setters or getters are not
implemented, and the code from the stubs is left instead, then it
should be ignored. However, if that becomes a pattern of the
implementation, then 1 should be given.
Rating 2 - Some things are not implemented exactly as the design
says, but the functionality of the component is still provided. For
example, for some input, the output is not exactly as the design
provides. If there is no effect on the functionality of the component
as a whole, especially if the method is not a public one, then this
score should be given.
Rating 3 - The implementation follows the design documentation.
This score applies even if one or two minor things are not implemented
as the design says. For example, some exception handling may not be
implemented exactly as outlined in the design, but there should be no
influence on the functionality.
Rating 4 - The implementation is a quality one, follows the design documentation, and may even have some improvements.
|
Scale (1-4)
|
50.0
|
N/A
|
Question 1.1.2
The implementation correctly uses the technologies that are specific to the component.
Question 1.1.2
The implementation correctly uses the technologies that are specific to the component.
The reviewer should check if the technologies and components specific
to the component are used and used properly. For example, if a
singleton pattern is required--Is it implemented correctly? In a thread
safe manner? Are TopCoder components or other third party libraries
used properly? Are other technologies used or implemented properly
(e.g. XML, JDBC, EJB, servlet, JSP)?
Rating 1 - Components and technologies are not used, or used
improperly affecting the functionality of the component or making the
component unusable.
Rating 2 - Some components and technologies are not used, which
that slightly influences the performance or results in excessive
amounts of code. Same score applies if some components and technologies
are not used as the best practice dictates, but the final goal is
achieved nevertheless.
Rating 3 - Components and technologies are used properly.
Rating 4 - Components and technologies are used properly beyond
what is outlined in the design. The implementation is not a simple
copy/paste of the code provided in the spec. It is clear that the
developer has done some research of his/her own (or already possessed
the knowledge). This is the case usually when the design does a poor
job in explaining how the technologies and components should be used.
|
Scale (1-4)
|
25.0
|
N/A
|
Question 1.1.3
The submission properly implements required algorithms as defined in section 1.
Question 1.1.3
The submission properly implements required algorithms as defined in section 1.
3 of the Component Specification.
The reviewer should look at the presence and quality of the
required algorithms. All algorithms must be implemented as described in
the algorithms section. Improvements are allowed and encouraged, as
long they are properly explained and documented. They do not
necessarily have to be approved in the forums, because they can be
considered a competitive advantage, but they should be at least
approved by the PM in a private mail. Fixing mistakes is not considered
an improvement. If an algorithm has mistakes in the design or it is not
appropriate, then it is up to the developer to fix it or work with the
designer on it.
Rating 1 - Some algorithms are missing or are implemented so poorly
that the component does not work in the way it was intended to.
Rating 2 - Some algorithms are not implemented as the design
specifies, and this slightly affects the performance of the component
or the elegance of the implementation.
Rating 3 - The algorithms are implemented properly.
Rating 4 - All algorithms are implemented properly and efficiently
and the developer brings improvements beyond the design. Direct
translations of the pseudocode from the spec (or even copy/paste)
should not be awarded with this score.
|
Scale (1-4)
|
25.0
|
N/A
|
|
Group:
Definitions
|
Weight
10.0
|
|
Section:
Definitions
|
Weight:100.0
|
Question 2.1.1
All classes, methods and variables declarations are exactly as they are
defined in the design documents (visibility, types, modifiers, names,
exception list).
Question 2.1.1
All classes, methods and variables declarations are exactly as they are
defined in the design documents (visibility, types, modifiers, names,
exception list). The reviewer should
verify the conformity of the implementation to the design. No changes
and no missing entities are permitted (unless previously approved by
the designer in the forums).
Rating 1 - Some entities are missing or are changed in a way that
makes the component no longer able to provide some functionality or the
usage is changed.
Rating 2 - The API is affected but the usage remains the same
(changes in names, added exceptions, widened visibilities or changes in
types).
Rating 3 - One or two changes are present that have no effect on the usage (i.e., final modifiers).
Rating 4 - Everything is declared exactly as in the design.
|
Scale (1-4)
|
40.0
|
N/A
|
Question 2.1.2
No additional public or protected entities are present in the design.
Question 2.1.2
No additional public or protected entities are present in the design.
The reviewer should check whether there are additional entities and
whether they are reasonable additions. Package private and protected
variables are not allowed. Package private methods are allowed, as long
as they fit naturally into the design. Package private classes are
allowed also, if they are used to provide helper methods. Private
variables, methods and inner classes are allowed. All added entities
must follow the language naming conventions and must use proper
English. Note that when there are multiple packages, helper classes may
need to be public. In this case, the restriction about adding public
classes and methods is relaxed.
Rating 1 - Many restricted entities are added without being necessary or the additions are not explained at all.
Rating 2 - Entities are added and they are reasonable, but the reasons are not well explained.
Rating 3 - The added entities seem fine. If they have naming
problems or use incorrect English, then this score should be given.
However, if the problems are more than just a few typos, then lower
scores can be considered.
Rating 4 - Nothing is added or the added entities are well justified, well named and properly documented.
|
Scale (1-4)
|
30.0
|
N/A
|
Question 2.1.3
The implementation properly maps class relationships.
Question 2.1.3
The implementation properly maps class relationships.
The reviewer should check if the interaction between the classes
conforms to the relationships defined by the design. All defined
relationships must be implemented and no additional relationships can
be introduced. For example, package private methods are a form of
dependency between the owner class and the caller class. The developer
is allowed to add package private methods only when the dependency
already exists.
Rating 1 - There are relationships that are not implemented which
seriously affect the component (missing inheritance, missing
associations, unused helper classes that result in unused code) or the
added relationships break design patterns (creates coupling between
classes).
Rating 2 - Some relationships are not implemented but they do not
affect the component (for example a dependency to a class is not used,
and an alternae route is used for getting some information) or some
relationships are added without being necessary that do not break any
design pattern and do not tighten the coupling between the classes
unnecessarily.
Rating 3 - All relationships are implemented properly but some
minor additional relationships are present. These additional
relationships must be necessary to the design (the designer has
overlooked the issues and there is no reasonable way to eliminate them)
but the developer added them without prior approval from the designer.
Rating 4 - All relationships are implemented properly and no additional relationships are present.
|
Scale (1-4)
|
30.0
|
N/A
|
|
Group:
Code Review
|
Weight
15.0
|
|
Section:
Code Review
|
Weight:100.0
|
Question 3.1.1
The object types defined in the implementation are the best choice for
the intended usage.
Question 3.1.1
The object types defined in the implementation are the best choice for
the intended usage. The reviewer should look
here for variable and object types that are not the best choice (from a
performance or memory consumption point of view). For example, using a
Vector instead of an array. Interfaces should be used for attribute
types instead of the concrete implementation classes where possible
(e.g., List instead of ArrayList). Efficiency is a primary concern
here. For example, HashMaps should be used instead of TreeMaps, unless
key order is important.
Rating 1 - Sub-efficient object types are consistently used and this could potentially affect the performance of the component.
Rating 2 - Some less efficient object types are used but this is not a pattern of misuse throughout the implementation.
Rating 3 - Concrete classes are used instead of interfaces as variable types.
Rating 4 - No better object types can be found and interfaces are used everywhere as variable types.
|
Scale (1-4)
|
20.0
|
N/A
|
Question 3.1.2
There is no useless code.
Question 3.1.2
There is no useless code.
The reviewer should look for pieces of code that are not needed. Such
code includes emulating standard Java functionality (such as array
copying), code that can be easily simplified, unused variables,
assignments to variables that are not used afterwards.
Rating 1 - Useless code is present in many places and that seems to be a pattern in the implementation.
Rating 2 - There are some pieces of code that could be simplified with little modification.
Rating 3 - Some useless code appears by accident.
Rating 4 - No useless code can be found.
|
Scale (1-4)
|
10.0
|
N/A
|
Question 3.1.3
There is no code redundancy.
Question 3.1.3
There is no code redundancy.
The reviewer should score here how well the developer managed to avoid
code redundancy. There should be no duplicated pieces of code. The
developer should factor out code into helper classes or private methods
and implement overloads if possible. This factorisation should not go
to the opposite extreme either. The end result should not be a class
with many small helper methods that do very little. Every method used
to factor code should have well defined functionality and should fit
naturally in the design.
Rating 1 - The code is consistently duplicated. Large pieces of
common code are copied in different places and there seems to be no
effort to avoid such situations.
Rating 2 - Some duplication exists but there are signs that the developer paid some attention to redundancy.
Rating 3 - No code redundancy exists.
Rating 4 - No code redundancy exists and the developer uses elegant techniques to avoid it.
|
Scale (1-4)
|
20.0
|
N/A
|
Question 3.1.4
The code is clear and efficient.
Question 3.1.4
The code is clear and efficient.
The reviewer is supposed to score here the clarity, the elegance and
the efficiency of the code. The code should not be more complicated
than it needs to be for what it does. It should not use complicated
`if’ constructs that make it hard to follow. There should not be huge
pieces of code. Where needed, private methods should be used to reduce
the complexity. The code should be as efficient as possible and
different optimisation techniques could be used to achieve that (e.g.,
caching information, breaking out of loops once the result is
obtained). However, the optimisations should be used wisely without
going to the opposite extreme where the optimisations affect the
clarity and the elegance of the code, without bringing significant
benefits.
Rating 1 - Complicated code is written for simple tasks to such a
degree that the code can no longer be followed. Unnecessary
complications and sub-efficient code is a pattern in this
implementation. The code is neither clear nor efficient.
Rating 2 - The code clarity and efficiency could benefit from some
improvements but it is obvious that the developer was concerned with
these aspects. The same score should be given if the balance between
clarity and efficiency is not right.
Rating 3 - The code is clear and efficient where needed. This
score should be given if there aren’t any obvious places that need
improvement but the developer did not show any special skills in the
written code.
Rating 4 - The code is clear and easy to understand. Necessary
optimisations are used but without going to the extreme of sacrificing
the code clarity for insignificant gains. The developer has shown
obvious skills in writing clear and efficient code.
|
Scale (1-4)
|
30.0
|
N/A
|
Question 3.1.5
The thrown exceptions provide suitable error messages and cause (where appropriate).
Question 3.1.5
The thrown exceptions provide suitable error messages and cause (where appropriate).
The reviewer should check whether the exceptions provide useful error
messages.The spelling of the messages should be checked, too.
Rating 1 - No messages at all or the messages are so poorly written that they aren’t very useful.
Rating 2 - Consistent errors in messages are present but the messages are still comprehendable.
Rating 3 - Some minor typos or some isolated situations in which the messages are missing.
Rating 4 - Meaningful and correct error messages are provided for each thrown exception.
|
Scale (1-4)
|
10.0
|
N/A
|
Question 3.1.6
All code, including test cases, follows the TopCoder coding conventions.
Question 3.1.6
All code, including test cases, follows the TopCoder coding conventions.
The reviewer should check here the code style used by the developer.
Tools such as Checkstyle should be used to properly check it. In
addition, there should be no tabs, proper tags (author, version) and
copyright section. Because there are tools to check the code style
automatically, nothing less than perfect from the code style point of
view should be tolerated.
Rating 1 - Consistent code violations are present to such a degree that the code looks bad.
Rating 2 - Many code violations are present, but when looking at the code, it still seems professional.
Rating 3 - Some minor code violations are present here and there.
Rating 4 - The code style is perfect and every element is present.
|
Scale (1-4)
|
10.0
|
N/A
|
|
Group:
Documentation
|
Weight
15.0
|
|
Section:
Documentation
|
Weight:100.0
|
Question 4.1.1
The implementation code contains detailed documentation for classes,
written in Javadoc / XML style as required by the Java / C# coding
standards.
Question 4.1.1
The implementation code contains detailed documentation for classes,
written in Javadoc / XML style as required by the Java / C# coding
standards. The reviewer should look
at this from an application developer standpoint. Class documentation
should contain a description of the class and its purpose. The
documentation should emphasize how the class will be used and also if
it is subject to future extensions (subclassing, for example). Class
documentation should contain code examples of class usage where this is
the case.
Rating 1 - Documentation is missing for one or more classes or it
proves to be consistently unhelpful. The documentation provided by the
developer does not clarify how most of the classes will be used, by
providing simple comments that do not bring additional value to the
name of the class.
Rating 2 - Documentation exists for each class in the design but
it provides little help to the developer; it is missing details
regarding the way a class is intended to be used.
Rating 3 - Documentation is complete and adequate to use the
component but requires further minor clarifications in several
situations.
Rating 4 - Documentation is complete and provides full details to
the application developer using this component. The developer will
likely not require any other details on how the component will be used.
|
Scale (1-4)
|
20.833334
|
N/A
|
Question 4.1.2
The implementation code contains detailed documentation for methods,
written in Javadoc / XML style as required by the Java / C# coding
standards.
Question 4.1.2
The implementation code contains detailed documentation for methods,
written in Javadoc / XML style as required by the Java / C# coding
standards. The reviewer should look
at this from an application developer standpoint. Method documentation
should contain a detailed description of the method which can include:
intent of method, pre and post conditions, side effects, dependencies,
implementation notes, who should be calling this method, whether the
method should or should not be overridden, where to invoke super when
overriding, control flow or state dependencies that need to exist
before calling this method.
All required tags defining parameters, return type and exceptions should be present and correctly describe method details.
Method documentation should contain code examples where appropriate.
Rating 1 - Documentation is consistently missing or consistently
unhelpful. A majority of the methods either lack documentation or do
not provide required details.
Rating 2 - Documentation is missing on at least one method or provides little help to the developer.
Rating 3 - Documentation is complete and adequate to use the component but may require further clarifications.
Rating 4 - Documentation is complete and provides full details to
the application developer using this component. The developer should
not require any additional information on how the component will be
used.
|
Scale (1-4)
|
20.833334
|
N/A
|
Question 4.1.3
The implementation code contains detailed documentation for variables,
written in Javadoc / XML style as required by the Java / C# coding
standards.
Question 4.1.3
The implementation code contains detailed documentation for variables,
written in Javadoc / XML style as required by the Java / C# coding
standards. The reviewer should look
at this from an application developer standpoint. Variable
documentation should contain a description of the variable role and
purpose, implementation notes and whether it is intended to be used in
subclasses. Variable documentation should exist for all variables in
the design, regardless of the visibility of the variable.
Rating 1 - Documentation is consistently missing or consistently
unhelpful. A majority of the variables either miss documentation or do
not provide required details.
Rating 2 - Documentation is missing on at least one variable or provides little help to the developer.
Rating 3 - Documentation is complete and adequate to use the component but may require further clarifications.
Rating 4 - Documentation is complete and provides full details to
the application developer using this component. The developer should
not require any additional information on how the component will be
used.
|
Scale (1-4)
|
8.333333
|
N/A
|
Question 4.1.4
The implementation code contains detailed documentation.
Question 4.1.4
The implementation code contains detailed documentation.
The reviewer should look at this from a future component maintenance
developer standpoint. This issue also ensures that there are no useless
comments that pollute source code and make it hard to understand. At a
minimum, the developer should provide meaningful comments for blocks of
code in methods, describing what it is trying to do, the assumptions
made and the way it is done.
Rating 1 - Documentation is consistently missing or consistently not helpful.
Rating 2 - Documentation is missing in at least one important
algorithm / code block or consistently provides little help to the
developer. Documentation contains useless comments that do not provide
any value to the implementation, but only make it harder to read /
understand.
Rating 3 - Documentation is complete and adequate to understand
the implementation, but there may be several places where it can
further be enhanced with useful details, or simplified by removing
useless comments.
Rating 4 - Documentation is clear, complete and concise, helping in clarifying implementation decisions and details.
|
Scale (1-4)
|
16.666666
|
N/A
|
Question 4.1.5
There are no errors and no warnings while generating the Javadoc / XML documentation.
Question 4.1.5
There are no errors and no warnings while generating the Javadoc / XML documentation.
That means the documentation must be perfect from a syntactical point
of view. There should be no missing tags, no additional tags, not even
for private members or inner classes. Tools such as javadoc, Checkstyle
or features of the modern IDEs should be used to check it.
No - The documentation misses documentation tags or generates warnings and errors for different other reasons.
Yes - The documentation is correct and complete.
|
Yes/No
|
8.333333
|
N/A
|
Question 4.1.6
The component documentation contains no grammatical or spelling errors.
Question 4.1.6
The component documentation contains no grammatical or spelling errors.
Rating 1 - The developer made so many grammatical or spelling errors
that one cannot understand what the developer is trying to relate.
Rating 2 - The developer made a number of grammatical or spelling
errors but the overall knowledge transfer can be made with multiple
readings. Rating 3 - The developer made some grammatical or spelling errors but the points were quickly understandable.
Rating 4 - The developer was concise and made no grammatical or spelling errors.
|
Scale (1-4)
|
8.333333
|
N/A
|
Question 4.1.7
The algorithms, test setup, dependencies, and demo sections of the
Component Specification document have been properly updated if
necessary.
Question 4.1.7
The algorithms, test setup, dependencies, and demo sections of the
Component Specification document have been properly updated if
necessary. If no changes were
needed, assign a 4 here. If other sections need to change to
reflect the implementation, they should be up to date as well.
Rating 1 - The Component Specification has not been updated and needs modifications.
Rating 2 - Major modifications are needed.
Rating 3 - Some minor modifications are needed.
Rating 4 - The Component Specification needs no modifications to properly reflect the component as developed.
|
Scale (1-4)
|
16.666666
|
N/A
|
|
Group:
Unit Test Cases
|
Weight
20.0
|
|
Section:
Unit Test Cases
|
Weight:100.0
|
Question 5.1.1
Unit Test Cases test all methods and constructors.
Question 5.1.1
Unit Test Cases test all methods and constructors.
The reviewer should verify if for each public method and constructor
defined by the component, the developer provided test methods. The
reviewer should focus on the existence of the test methods, instead of
focusing on their quality. The Test Case containing the demonstration
of the component will not be considered when counting existing test
methods.
Rating 1 - Most of the test methods are missing or the existing
test methods incorrectly test the functionality of the component.
Rating 2 - The submission does not contain test methods for
trivial functionality of the component, such as set / get methods or
exception constructors. However, this does not appear to be a pattern
throughout the unit testing.
Rating 3 - There is at least one test method for each public method and constructor.
Rating 4 - There are several test methods for each public method and constructor.
|
Scale (1-4)
|
25.0
|
N/A
|
Question 5.1.2
Unit Test cases contain an implementation or a demonstration of how the
component will be used.
Question 5.1.2
Unit Test cases contain an implementation or a demonstration of how the
component will be used. Unit Test cases should
contain at least an implementation of the “demo” provided by the
designer in the Component Specification (if one is provided). The
developer can and is encouraged to provide more test methods that
demonstrate the way the component will be used by a future client. The
test methods that are used as a demonstration should be grouped in the
same Test Case. If the Component Specification does not contain a
proper “demo” section, the developer is still responsible for providing
one in their unit test cases.
The reviewer should look at this section from the point of view of
a client and identify if the provided demonstration suits the needs of
such a client, by helping the client understand how the component is
used.
Rating 1 - No demonstration of the component usage is provided, or
the one provided is not helpful or does not refer to important basic
functionality of the component. Basic functionality is that
functionality that is essential to the component.
Rating 2 - The provided demonstration properly describes the usage
of the basic functionality of the component, but fails to present a
demonstration of additional non-basic functionality or fails to
implement the “demo” in the Component Specification.
Rating 3 - The provided demonstration properly addresses the usage
of the component and contains an implementation of the “demo” section
as provided by the designer in the Component Specification.
Rating 4 - The provided demonstration is clear, helpful and
addresses all the needs of a client. All basic and additional
functionality of the component is described, and properly docume
|
Scale (1-4)
|
10.0
|
N/A
|
Question 5.1.3
Unit Test Cases thoroughly and correctly test all methods and constructors.
Question 5.1.3
Unit Test Cases thoroughly and correctly test all methods and constructors.
Unit tests evaluate every public method in the component to ensure that
valid and invalid inputs are handled properly and as defined in the
documentation. The reviewer should focus on verifying the correctness
and the quality of the test methods provided by the developer. The
existing test methods should correctly test the functionality of the
component as detailed in the documentation.
The Unit Test Cases consider using real data and appropriately
configure the system as it is expected to be in the real world. For
example, if a component implies using a database, the Unit Test Cases
should provide test methods that interact with the database, instead of
providing mock-ups of data.
Rating 1 - The unit tests do not correctly and thoroughly test the
basic functionality of the component. The developer provided tests that
address only valid or invalid arguments, or do not test the component
using real values and system configuration. Basic functionality is that
functionality that is essential to the component.
Rating 2 - The unit tests do not thoroughly test the additional
functionality of the component. The developer provided tests that
address only valid or invalid arguments, or does not test the component
using real values and system configuration. Rating 3 - The unit tests correctly and thoroughly test the
functionality of the component. Basic and additional functionality of
the component are addressed and tested using real values and system
configuration, as it is expected to be run on the client’s computer.
Rating 4 - The submission is properly tested using different types
of tests that address different aspects of each tested method or
constructor. For example, if an algorithm has time constraints it
should be tested not only for accuracy but also to see if it respects
the constraints. When testing for accuracy, an algorithm should
be presented with different sets of data.
|
Scale (1-4)
|
25.0
|
N/A
|
Question 5.1.4
Where applicable, Unit Test Cases properly configure the test environment.
Question 5.1.4
Where applicable, Unit Test Cases properly configure the test environment.
The reviewer should check if the Unit Test Cases wisely configure the
test environment using setup and teardown methods, without duplicating
the configuration with each test method. Also, the configuration should
address only required items, and should not contain more configurations
than needed. The reviewer should also look for extra initializations
that affect the performance of unit testing.
The unit test methods should not contain configuration details that
are system specific. They must be stored in separate configuration
files and loaded when needed.
Rating 1 - The test environment is not configured using setup and
teardown methods, but instead the configuration is repeated over and
over for a majority of the test methods, or the test methods contain
configuration details that should have been stored in configuration
files.
Rating 2 - In several places, setup and teardown contain
configuration and initialization sections that either do not address
all entities of the environment, or address more entities than needed,
or affect the performance of the unit testing.
Rating 3 - Setup and teardown contain configuration and
initialization sections that either do not address all entities of the
environment, or address more entities than needed. The missed or added
entities should represent minor details, such as repeatedly
initializing the same variable without affecting the performance or the
integrity of the unit testing.
Rating 4 - Setup and teardown are used wisely for configuring the
test environment, and configuration details that are system specific
are stored in configuration files.
|
Scale (1-4)
|
10.0
|
N/A
|
Question 5.1.5
Where applicable, files used in Unit Test Cases exist in the /test_files directory.
Question 5.1.5
Where applicable, files used in Unit Test Cases exist in the /test_files directory.
The reviewer should verify that all test files and configuration files
used in Unit Testing exist and are located in the /test_files
directory.
No - The developer either provided invalid files or did not store them in the appropriate /test_files directory.
Yes - All files used in the Unit Testing exist in the /test_files
directory or there are no test files or configuration files used.
|
Yes/No
|
5.0
|
N/A
|
Question 5.1.6
Where applicable, Unit Test cases do not leave temporary files on the
file system, open network or database connections, open files or
streams after testing is complete.
Question 5.1.6
Where applicable, Unit Test cases do not leave temporary files on the
file system, open network or database connections, open files or
streams after testing is complete. The system is not
affected after unit testing of the component, meaning that no temporary
files are left on the file system, no network / database connections
are left open, no files / streams are left open.
No - Temporary files are left on the file system or database / network connections are not closed after testing is complete.
Yes - Temporary files are removed from the file system after
testing is complete and temporary files are created only when needed.
|
Yes/No
|
5.0
|
N/A
|
Question 5.1.7
The unit test code contains detailed documentation for classes, methods
and variables as defined in the Deliverables Document.
Question 5.1.7
The unit test code contains detailed documentation for classes, methods
and variables as defined in the Deliverables Document. The reviewer should look
at this from a future component maintenance developer standpoint. Unit
tests documentation should contain details about what is tested (which
method / constructor), the expected behaviour and the arguments used.
The quality of the documentation has to be the same as for the
component code.
Rating 1 - Documentation is consistently missing or consistently not helpful.
Rating 2 - Documentation is missing on at least one test method or
consistently provides little help to the maintenance developer.
Rating 3 - Documentation is complete and adequate to use the component but may require further clarifications.
Rating 4 - Documentation is complete and provides full details to
the developer maintaining this component. The developer should not
require any additional information on how the testing of the component
will be maintained or enhanced.
|
Scale (1-4)
|
20.0
|
N/A
|
|
Group:
Overall Comments
|
Weight
15.0
|
|
Section:
Overall Comments
|
Weight:100.0
|
Question 6.1.1
The reviewer should evaluate the submission as a whole in this item.
Question 6.1.1
The reviewer should evaluate the submission as a whole in this item.
The evaluation criteria include how much work needs to be done to
complete it, whether the submission deserves to pass or not, and it’s
level of quality compared to an average submission that meets all
requirements.
Rating 1 - The submission is lacking in many areas. In order to complete it, much work needs to be done.
Rating 2 - The submission is lacking in many areas but the
component still works and it is possible to test it. The problems it
has should be fixable without much effort.
Rating 3 - The submission meets all requirements but it doesn’t
excel in any way. The fixes that need to be done should not be
significant. The submission should be of average quality.
Rating 4 - The submission excels in many areas. All requirements
are met and some are exceeded. In order to complete the component, only
minor items need to be fixed. This submission is clearly above average.
|
Scale (1-4)
|
100.0
|
N/A
|
|