Peer Review Log - Software Education

Software Education Requirements Methodology Pack
533579646
Peer Review Log
This document is a manual log for recording peer review results regarding a work product.
Rule set to be used:
Rule
ID
Description
Unclear
G01
Statements and terms shall be clear and unambiguous.
The reader shall not have to make assumptions.
Inconsistent
G02
Statements, terms and references shall be consistent within the
work product and with related work products.
Inappropriate
G03
Incorrect
Missing
G04
G05
Verbose
G06
Complex
G07
All statements shall be appropriate to the work product. For
example, you comply with policy but follow the process.
Assumptions, facts and solutions shall be validated by a subject
matter expert.
All relevant information shall be included in the work product.
Statements and terms shall be concise.
The level of detail shall be appropriate for the work product type.
Statements shall be broken down into their most elementary
form.
Terms, words, acronyms and abbreviations shall be clearly
defined, using or referencing a glossary if necessary.
The first occurrence in the work product of an acronym or
abbreviation shall appear in brackets following the term in full.
Requirements, processes, statements and terms shall be
explained once and thereafter mentioned using a location
reference.
Definition
Required
G08
Repeated
G09
Unsourced
G10
Not Traceable
G11
The source of each statement taken from another work product
shall be identified exactly and in detail.
It shall be possible to trace from the solutions at the end point
back to the requirements or conditions at the start point within
the work product and in related work products.
Spelling/Grammar
G12
Work products shall be free from errors in spelling and grammar
and shall have been subjected to all relevant automated checks.
Copyright © 2008 Software Education Group. All rights reserved.Page 1 of 4
Software Education Requirements Methodology Pack
533579646
Item types
The definition of items, issues and the like is as follows:
 An Item is an issue, process improvement or question raised when checking a work
product or during the review meeting. The term is generally only used to refer to an entry
in the Review Log (e.g., there were fifteen items raised, or, sort the items by page
number).
 An Issue means anything that appears to be a defect. An issue is only a potential defect
and is not confirmed as one until the Author has addressed it during the Correction
stage. There are four types of issues:
 Supermajor – This issus is so significant that it places the project at risk
 Major – This issue has significant downstream impact if not corrected.
 Minor – This issue has some downstream impact if not corrected.
 Cosmetic – This issue is cosmetic (e.g., an error in format) and will not cause a
malfunction or significant unnecessary downstream work.
 A Process Improvement is a suggestion to improve any relevant procedure, tool or
other artefact belonging to a process.
 A Question is a query for the Author to respond to during the Review Meeting. A
question is generally used to determine whether something is an issue or not.
Copyright © 2008 Software Education Group. All rights reserved.Page 2 of 4
Software Education Requirements Methodology Pack
533579646
Manual Peer Review Log
1
Work Product Identification
Work Product Name
Work Product Doc ID
2
3
Work Product Version
Peer Review Details
Author
Type of Peer Review
Recorder
Date and Time
Reviewer
Venue
Peer Review Duration
Number of Items
Log
Location is the place in the work product that the item is found. Item is a description of the item. Valid Item Types are
Supermajor, Major, Minor, Cosmetic, Process and Question. The types are further defined above.
No
Location
Item
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Copyright © 2008 Software Education Group. All rights reserved.Page 3 of 4
Rule ID /
Description
Item Type
Software Education Requirements Methodology Pack
No
Location
Item
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
Copyright © 2008 Software Education Group. All rights reserved.Page 4 of 4
533579646
Rule ID /
Description
Item Type