Software Engineering: Journal Formats
The following are some suggested formats for reports
for the assignments in the course. They are based on forms
designed by Watts. S. Humphrey and given in his book
"A Discipline for Software Engineering"
The best way to create these is to use a spreadsheet. For example the one
provided with Microsoft Office.
Office also has facilities for creating the other documentation that is
required such as the diagrams and the narrative texts. Please use these.
Time Report
<![CDATA[
Time Recording
Name: X. Prog Project: Homework 1
Date Start Stop Interrupts Delta Phase Comments
01/19 16:25 16:30 0 5 Planning
16:35 17:05 0 30 Design
17:05 17:40 3 32 code Phone Call
17:40 17:55 0 15 compile
17:55 18:00 0 5 Test
01/21 09:01 09:25 0 24 PostMortem
]]>
Error Report
<![CDATA[
Defect Report
Name: X. Prog Project: Homework 1
Date Number Type Inject Remove Fix Time Fix Defect
01/10/95 18 80 Design Test 47
Description: Step pointer advanced an extra step when Cycle
counter loop exited
Date Number Type Inject Remove Fix Time Fix Defect
19 20 Test Test 1 18
Description: Misspelled Stepcounter while correcting #18
]]>
Error Type Classification
<![CDATA[
Type Type Description
Number Name
10 Documentation Comments, messages
20 Syntax Spelling, punctuation, typos, instruction formats
30 Build, package change managment, library, version control
40 Assignment declaration, duplicate names, scope, limits
50 Interface procedure calls and references, I/O, user formats
60 Checking Error messages, inadequate checks
70 Data structure, content
80 Function logic, pointers, loops, recursion
computation, function defects
90 System configuration, timing, memory
100 Environment design, compile, test, or other system
support problems
]]>
To return to the software engineering home page click
HERE
Jonathan Hodgson
Last Change: Jan 13th 1995