Report writingfinal reportfall 2009

Agenda• Each group make a short presentation of

their project addressing the challenges of the project

• Feedback from students and counsellors• Report writing• Examination• The next meeting

Final project elements

• Documentation of • Product objectives• Learning objectives

• Documentation of necessary process activities to reach a solution

• Documentation of the developed product

Number of reports

• 1 report?• 2 reports?• 3 reports?

Evaluation criteria Remembering: recall or remember information

Understanding: explain ideas or concepts

Applying: use the information in a new way

Analyzing: distinguish between the different parts

Evaluating: justify a stand or decision

Creating: create new product or point of view

High order skills

Low order skills

Bloom activities I (verbs)Remembering: • Recognising, listing, describing, identifying,

retrieving, naming, locating, finding Understanding: • Interpreting, Summarising, inferring,

paraphrasing, classifying, comparing, explaining, exemplifying

Applying: • Implementing, carrying out, using, executing

Bloom activities II (verbs)Analyzing: • Comparing, organising, deconstructing,

Attributing, outlining, finding, structuring, integrating

Evaluating: • Checking, hypothesising, critiquing,

Experimenting, judging, testing, Detecting, Monitoring

Creating: • Designing, constructing, planning, producing,

inventing, devising, making

Knowledge adaptationRemembering parts• Reproduction of knowledge from a source (not

copying)

Understanding parts • Adapted knowledge from a source, i.e. involvement

of:•Own examples•Own experiences•Other viewpoints•Summary of a source

Use of sources• Figures• Quotes (referred to in “ “) • Source material - i.e.. articles, internet pages,

books

References where to sources are usedSources must be specified in the literature listInternet references • enclose the original on CD• They tend to disappear

Copying is prohibited!

Process report – typical structure1. Preface2. Introduction3. Project establishment4. Methodology5. Roles and task division6. Planning7. “Actual process”8. Evaluation / conclusion

Product report – typical structure1. Preface2. Introduction3. Business modelling4. Requirements5. Technology6. Architecture7. Design8. Implementation9. Test10.Evaluation / conclusion

General requirements - for all chaptersWriter and co-writer!!Introductions• Introduce or present the chapter

• Reading guide and target group• Purpose of the chapter• Structure of the chapter

Partial conclusions:• Summary of results and discussions

Rules of thumb

• Many figures / diagrams• Many examples• Distinct layout (standards)

• chapter/paragraph numbering• Figure and enclosure numbering• Header and footer

• Correct figure-, enclosure, paragraph references• Logical order of chapters/paragraphs (“red

thread”)• As few forward references as possible• Let many and different people read the proofs

Examination

Group• Presentation of project (30 min) does

not influence the gradeIndividual• Discussion between student and

examinator (20 min)• Does NOT start with a student

presentation

Important datesNext joint meeting−8th October at 14.00

Handing in−Friday 13th November 10.00

Examination−Week 48: 23th – 27th November

Graduation−4th December

Process / Product - preface

• Which report• Which education• Who have participated• When

Process / Product - Introduction

• Introduction to the project/subject• Purpose of the report• Structure of the report• Target group for the individual parts

Process report - Project establishment

• Character of the commission• Learning objectives

• Indivdual / Collective• Process / Product

• Resources• Drawing up contracts

• intern/extern, formal/informal, process/product

• Counsellor contract• Standards

Process report - Methodology

• Considerations• Choice• Argumentation for choice

Process report - Roles and task division• Qualification requirements for the

project•Depends on the task •Might depend on the methodology

• Personal choices / specialization•Might influence the final conclusion of

the report

Process report - Planning

• Might depend on the methodology

Contains one or more of the following• Project plan• Gant chart• Milestones with evaluation criteria• Risk analysis• Estimates

Process report - Actual processDetailed plan for iterations, sprints, phases

…..

Possible enclosures• Decision diary• Minutes from meetings

• Planning• Evaluation• Adjustment

• Plan• Proces• Reflection

Process report - Evaluation / conclusion• Summary of partial evaluations• Summary of results of your process as a

hole• Evaluation of the learning objectives

• Individual / Collective• Process

• Generalisation of theory • Systems development method• Organisation theory

Product – Business modelling

• Introduction of the costumer company• Relevant structures in the costumer

company• The projects planned impact on the

costumer company• ….

Product - Requirements

• Scope of the product • Listing of requirements for the product• Documentation of the requirements

• Might depend on the methodology

Product - Technology

• Considerations•Customers viewpoint•Learning objectives

• Choice of technology• Argumentation for choice

•Pros and cons

Product - Architecture

• Presentation of different alternatives • Choice of architecture

• Argumentation for choice

• Documentation of architecture

Depends on the chosen technology

Product - Design• Documentation of design

• Presentation of alternatives• Argumentation for chosen design

• Patterns• Database• …..• Might be a schism if using an agile

methodology• Still need to communicate the design

Product - Implementation• Commented bits of code• Focus on subjects relevant to product learning

objectives i.e.:•New technologies•Architecture •New patterns…

• Enclosure• Full code, with index and pages numbered in

succession•CD - in an readable format!•printed

Product - Test• Documentation of test

• Unittest• Acceptest• …

• Results of tests• Found errors / misunderstandings• Corrections

• If Test Driven Design• Test chapter might appear earlier in the report

Product report - Evaluation / conclusion• Status for the product

• Flaws and defects• Further development

• Evaluation of product learning objectives• Generalisation of product learning

objectives• Technology• Architecture• Patterns• ……