Writing Reports
Writing Reports
Academic Writing
A quick tutorial (from my perspective)
Why write….
• To demonstrate knowledge
• Paraphrasing
• Rewrite, expand
• Text summarizing
• Reference generation
• Grammar checking
• Plagiarism tool
NB! Only guidelines
Grade A - Excellent
• An outstanding thesis which clearly demonstrates a talent for research and/or originality, in a
national perspective.
• The candidate has very good insight into the scientific theory and methods in his/her field and has
demonstrated scientific knowledge at a very high level. The objectives of the thesis are well defined
and easy to understand.
• The candidate is able to select and apply relevant scientific methods convincingly, has all the technical skills
required for the work, can plan and conduct very advanced experiments or computations without help, and
works very independently.
• The thesis is considered very extensive and/or innovative. The analysis and discussion have an extremely
good scientific foundation and justification, and are clearly linked to the topic that is addressed. The
candidate demonstrates extremely good critical reflection and distinguishes clearly between his/her
contributions and the contributions from others.
• The form, structure and language in the thesis are at an extremely high level.
Grade F - Fail
• A thesis that does not satisfy the minimum requirements.
• The candidate does not have sufficient scientific knowledge and insight into the scientific theory
and methods in his/her field. The objectives of the thesis are not clearly defined or are lacking.
• The candidate demonstrates a lack of competence in the use of scientific methods, does not
have the required technical skills and independence for the work, and has scarcely utilized the
research group’s expertise in his/her own work.
• The thesis is considered very limited and fragmented. The analysis and discussion do not have an
adequate scientific foundation and justification, and are loosely linked to the topic hat is
discussed. The candidate does not demonstrate sufficient critical reflection, and does not clearly
distinguish between his/her contributions and the contributions from others.
• The thesis has major shortcomings with respect to form, structure, and language
Writing is hard …
think
expand shrink
edit write
Suggested template
Title • 11 pt serif fonts for body text.
Author
1. Introduction • Monospace fonts for code
2. Background
• About 75 characters per line
3. [Main content]
• Enumerate sections
4. Conclusions
References • In reports: no need for TOC or list
of figures.
Introduction
• Puts the report in context
• Why is your work important and interesting (you do not need recap the
history of computing).
… but get to the point quickly!
• Show that you have vast knowledge & understanding on the topic
• Establish yourself as an authority on the subject of the report
[May also be merged with introduction if there is not sufficient text to warrant a
separate section]
[Related work is similar to background, but more specific to the paper topic.]
Main Content
• Design / Implementation
• Describe what you worked on. How is it designed?
• Describe the challenges and problems?
• Describe alternatives and why you did not go for those?
• What were the tradeoffs?
• Algorithms listings, system architecture drawings, protocol diagrams
• API specs, data structures, ER diagrams
• Evaluation
• Describes how well your implementation worked
• Argue that you achieved your set goals
• Include graphs & statistics
Conclusions
• Summarize the report and what you have done
• No surprises here, you're not writing a crime novel (e.g., the butler did it)
• Active: Brown earlier showed that high stress can cause heart attacks.
It is crucial that
it is necessary that
there is a need => must, should
it is important that
cannot be avoided
Misc. other tips
• Sections indicate a set of paragraphs with similar topics, summarized by the title
• You can still talk about that topic elsewhere
• It’s better to write in the wrong place, than to not write at all
• You can always restructure later on
• .. but do not assume the reader remember what you talked about 1 page earlier
Suggested literature