Mantex

Tutorials, Study Guides & More

  • HOME
  • REVIEWS
  • TUTORIALS
  • HOW-TO
  • CONTACT
>> Home / Archives for Document structure

How to write a report

February 18, 2013 by Roy Johnson

planning, structure, writing, and presentation skills

What is a report?

How to write a ReportA report is a detailed and well-organised document that defines and analyses a subject or a problem.

A report should always be accurate, concise, clearly written, and well structured.

A report might also record a sequence of events, evaluate a product or a process, discuss a series of proposals, or make a number of recommendations.

A report should include all the information necessary for the reader to understand the topic under discussion and make informed decisions about it.


The purpose of a report

Reports are used in education, business, finance, government, manufacturing, and scientific research.

In small and medium companies they usually communicate information from one company to another. In large companies they communicate information between personnel.

You might write a report when applying for a grant; to accompany a business proposal; or to describe a project which has been commissioned.

Reports might also be important to record the progress of a business – as in a company’s annual report.

Reports do not have to be long – or boring. They should be clear and easy to understand, especially if they are written for somebody else.


How to write a report

Writing a report is often a major undertaking for many people. The task can be made easier by breaking it down into a series of steps. The following are recommended as guidelines for writing reports.

Stage 1 – Choose the type of report

Stage 2 – Decide the purpose of report

Stage 3 – Choose report sub-headings

Stage 4 – Assess your data

Stage 5 – Draft the report

Stage 6 – Edit and proof read

If you need to produce a report whose type is not discussed here, follow the same principles. That is – first of all think carefully about the form or kind of document you are going to produce.

It will help you enormously if you get hold of an example of the type of report you need to produce. In particular, study its structure, and use that as a model for what you have to write.

You might need to adapt another type of report for your purposes. If you need to create your own type of report, follow the guidelines for creating good structure in documents.

Acquaint yourself with some examples of various report types. This will help you to decide which type of report you need.


Stage 1 — Types of report

1. A meeting report communicates the details of a meeting to people who did not attend. It may also go to people who did attend, as a summary of events for future reference.

The minutes of a meeting record the major points made by a group of two or more people who conduct a meeting.

2. A project report is a record kept by the project manager, and is presented to management or sponsors. It usually details chronologically the events, achievements and attainment of a project’s targets and objectives.

3. A feasibility report is similar to a problem-recommendation report but it describes one possible solution in detail and makes recommendations.

4. A sales report gives the details of a salesperson’s contact with a specific customer or company – indicating whether or not sales have been made.

5. A status report tells the management what has been happening on a project, and to what degree it is going according to plan.

6. A problem recommendation report outlines the writer’s investigation into a particular problem and recommends a course of action to solve the problem

7. A site-visit report summarises the conditions which obtain at a particular location in relation to a project – such as the construction of a building.

8. A company report is the record of a business and its recent history, made usually at the end of a financial year. It combines management strategies, sales results, and accounts.


Stage 2 — The purpose of your report

The purpose of a report will have an effect on both its content and the manner in which it is presented.

A good starting point is to write out the purpose of the report in a sentence or two. This ‘purpose statement’ will help you to focus on your primary needs. It will help you by giving the report both a starting point and a goal.

Typical examples of purpose are to inform, instruct, persuade, or to record.

A report may have more than one purpose – just as it might have more than one audience. For instance, a company’s annual report is a statement for the directors, the shareholders, and the public in general.

An academic report (say, in science or engineering) may have a double purpose. First the recording of an experiement or a field visit. Second, demonstrating that the author is familiar with the conventions of academic writing in that discipline.

A commercial sales report might be used by regional and national sales managers, a finance controller, and the chief executive officer (CEO).

These various parties will be interested in different aspects of the report. And since each reader has different interests in the report’s content, it is important to plan the report so that it includes the information each reader is looking for.


Stage 3 — Report headings and sub-headings

Choose the sub-headings for your report from the following list. Doing this at the planning stage will help you to write a clear report which is easy for your recipient to read.

Arrange the sub-headings in conjunction with your main headings at a later stage. The following list of headings which belong with report types is arranged in alphabetical order.

Action needed

Example
Please select an appropriate time and place to meet and inform the members of the team.

Assumption

Example
The project team will consist of one half-time systems analyst and two full-time, experienced programmers.

Attachment

Example
You will find the following attachments which establish the legal status of this policy.

Background

Example
I met the Chair of Needwell last Thursday and we agreed that I would send you information regarding the expansion plans.

Benefit

Example
The benefits of a fully implemented WebCT system are as follows:

  • better utilisation of resources
  • a balanced production load
  • decreased stock in inventory
  • decreased order expediting
  • reduced production costs

Caution

Example
Although there is a new policy for internal promotion, there are more people qualified for advancement than there are slots available.

Constraint

Example
The union contract permits only eight hours work per day before overtime must be paid.

Contact

Example
If you or anyone in your department wants to submit comments on our new word processing equipment, send them in writing to J.Bloggs Staff Depot

Deadline

Example
These changes apply to all applications we receive on or after 10 October 2015

Decision needed

Example
Please let me know when we can meet to design a new form for travel reimbursement.

Implication

Example
If the Company adopts the proposed retirement policy we can anticipate the following:

  • a large pool of experienced executive talent for our T Project
  • improved morale among all employees approaching retirement age
  • slightly higher costs of medical expenses and insurance

Importance

Example
If we do not have our new word-processing equipment running by 17 September 2010, we will not be able to support the production goals.

Introduction

Example
The Fine Food Marketing Company has recently entered the health food industry with a brand new type of food supplement called Gatewell.

Law

Example
The commissioner of environmental quality engineering or his designee may issue orders in the name of the department of environmental quality on being presented with proof of the violation of any statute, rule, regulation, or code which the department is authorized to enforce.

Objective

Example
We expect that the new system will be fully operational by May 2006

Options

Example
The company has two staffing options available for this project

  1. use entirely new employees
  2. use a mix of employees and contractors

Policy

Example
This company will employ individuals without regard to race, colour, gender, or national origin.

Problem

Example
Our work processing system does not have the capability to handle special graphic presentations. This causes a loss of business.

Purpose

Example
The purpose of the meeting is to make and document an action plan for opening the Greenleaf Site.

Rationale

Example
Our decision to avoid genetically modified elements in our wines is based on the lack of evidence currently available concerning the effects of GM elements.

Recommendation

Example
In conclusion, we strongly recommend that new measures be put in place for testing our boilers for corrosion.

Reference

Example
Please refer to the Critical Quarterly for reviews on the publications mentioned in the body of this report.

Schedule

Example
The schedule below gives details of the staffing responsibilities

  • Week 1 Payroll
  • Week 2 Personnel
  • Week 3 Support Team

Source

Example
I found the statistics for the Boston Flyer in The Engineering Journal published May 2000.

Speaker

Example
Tuesday’s speaker will be Sir Harold Busby, Chairman of Astrolux.

Summary

Example
This report has examined the feasibility of a merger between Minibok and Fair Trading. It has examined the financial and social implications.


Stage 4 — Assess the data

Before sitting down to write your report, make sure you have all the research data to hand. Mark out each part of the data, allocating it to one of your sub-headings.

If you have some data which doesn’t fit any of the sub-headings, think carefully about whether to create a heading which fits the data or whether to discard the data as irrelevant.

It is perfectly normal to gather data which is not needed in the final report. Do not feel obliged to include material just because it exists.


Stage 5 — Draft the report

Draft your report in short sections, under each one of your headings or sub-headings. This way, you will be able to rearrange the sequence, or delete some content.

Working in short sections makes writing an easier process. Use the following guidelines for drafting the sections.

Create readability by structure

Your reader will digest the document most efficiently if the text is broken down into bite-size sections. Large dense blocks of text are overfacing and difficult for the eye to deal with.

Your sections should comprise no more than ten lines. Here is an example of the bite-size section.

Increased sales

New customers
The sales team has broken all records this month.
The number of new customers has rocketed from last month’s total of 10,000 to 12,975.

Additional bonuses
In view of this we are giving all members of the sales team an additional bonus of 0.5 per cent.

Create readability by relevance

Each section should contain one idea. Nothing else should be added. Extra ideas, even if they are connected with the subject, should be given their own paragraph.

In the example given above, the topic of increased sales stands alone. The extra topic of bonuses is related, but comprises a separate paragraph.

Create readability by navigation

Each topic in your report should have a signpost or a sub-heading. This prepares your reader for what is to follow.

It also helps the reader in referring back efficiently to a specific point or topic. In the example given above, each topic is signposted to prepare the reader for what is coming.

The heading ‘Increased sales’ introduces the main topic, whilst ‘new customers’ and ‘additional bonuses’ announce the sub-topics.

Create readability by verbal consistency

Your reader will digest your report quickly and efficiently if you use layout, headings, font style, and vocabulary consistently.

Reports are entirely functional and therefore quick, efficient reading is your objective.

In the example given above, vocabulary is used consistently. The word ‘sales’ is used both in the main heading and in the body text The word ‘customer’ is used both in the sub-heading and in the body text

Create readability by visual consistency

Consistency helps readers to find their way in a document. At every level of the document you should use consistency in:

Visual presentation

  • Font type and size
  • Page layout
  • Main Headings
  • Sub-headings
  • Bulleted lists
  • Numbered lists
  • Page numbering
  • Justification (right, left, centre, full)

Consistent language

  • Vocabulary
  • Sentence size
  • Sentence construction
  • Style of expression


Follow the guidelines on How to present documents to give your report a professional appearance.


Stage 6 — Edit and proof read

Editing and proof reading a substantial report might be a lengthy and time-consuming process. But it will make the difference between an amateur and a professional piece of work.

Editing is the process of checking your work very carefully in order to –

  • remove any spelling mistakes
  • check your grammar
  • make your punctuation consistent
  • re-write any clumsy expressions

Proof reading is the very last stage of making any changes. At this point it is assumed that the content of the report has been checked for accuracy, grammar, and punctuation.

Proof reading looks at the presentation of the text in even greater detail – mainly for matters of bibliographic and typographic consistency.

  • Capitalization of headings
  • Font size and style
  • Spacing between paragraphs
  • Regularity of indentation
  • Consistent use of italics and bold

Follow the guidelines on Editing your writing to produce a document which is free from minor blemishes.


Sample report structure

Title page

[This should normally include the following as a basic minimum]

the title of the report

the name of the author

or

the name of the organisation

the date

Acknowledgements

[If necessary – in longer reports]

A list of people and organisations who have helped in the production of the report.

Contents page

[Always included in any reports of more than a few pages]

A clear list of all the sections and sub-sections in the report – with page numbers.

If applicable, there should be a separate list of tables, figures, illustrations and appendices after the main index.

The headings in this list should correspond exactly with those in the main body of the report. Generate the list of contents after completing the report.

Terms of reference

[Sometimes included]

A definition of the task or the brief you were given. This is statement of the specific objective and purpose behind writing the report.

Even if you don’t include this as a heading, it is a vital process to go through in your planning.

  • What exactly is your report going to be about?
  • Who exactly is responsible for what?
  • How long have you got? What is your task timescale?
  • Why are you writing the report?
  • Who are you writing the report for?
  • What does your reader want to see?

Procedure

[sometimes included]

How your research was carried out; how the information was gathered and treated.

This section might also be called ‘methodology’ in some reports.

Materials and methods

[included if appropriate]

Similar to methodology or procedure, but more appropriate to scientific or engineering report writing. The following advice comes from Robert Barrass’ book Scientists Must Write (Chapman & Hall, 1978, pp.135-136).

1. List the equipment used and draw anything that requires description (unless this is very simple).

2. State the conditions of the experiment and the procedure, with any precautions necessary to ensure accuracy and safety. However, when several experiments are reported, some details may fit better in the appropriate parts of the Results section.

3. Write the stages in any new procedure in the order of implementation, and describe in detail any new technique or modifications of an established technique.

4. If necessary, refer to preliminary experiments and to any consequent changes in technique. Describe your controls adequately.

5. Include information on the purity and structure of the materials used, and on the source of the material and the method of preparation.

Summary

[usually included in longer reports]

This is a short summary of the entire report, created for those people who may not have time to read the entire document.

This is often called the Executive Summary (in business reporting), Abstract (in a dissertation or thesis) or Synopsis (in a scholarly work).

It’s a very brief outline of the report to give the potential reader a general idea of what it’s about. A statement of:

  • overall aims and specific objectives
  • method or procedure used
  • key findings
  • main conclusions and recommendations

Introduction

This might be optional, but writing an introduction will help you to describe your overall purpose.

This should show that you have fully understood the brief and that you are going to cover everything required. Indicate the basic structure of the report.

Include just a little background or context and indicate the reasons for writing the report. You may include your terms of reference and procedure or research methods if not covered elsewhere.

Your introduction will often give an indication of the conclusion to the report.

Write this last of all so that you know what it is you’re introducing. You could have a working introduction that is edited when the body of the report is complete.

Main body of the report

This is the substance of your report. The structure will vary according to the nature of the material being presented, with headings and sub-headings used to clearly indicate the different sections.

Charts, diagrams, tables, and illustrations can be used to reinforce the points your are making.

Sometimes it may be better to include these as an Appendix, particularly if they are long or complicated.

Do not include opinions, conclusions or recommendations in this section.

Results

[included mainly in scientific or engineering reports]

This section records your observations and would normally include statistics, tables or graphs.

These are called ‘findings’ in a business context.

Conclusion

[always included]

Your conclusion should state the implications of your findings, with deductions based on the facts described in your main body. Don’t include any new material here.

Recommendations

[if required]

These should follow on logically from your conclusion and be specific, measurable and achievable. They should propose how the situation or problem could be improved by suggesting action to be taken. A ‘statement of costs’ might be included if you are recommending changes that have financial implications.

Recommendations can be numbered for the sake of clarity.

Appendices

(if required)

An appendix (plural=appendices) is detailed documentation of points you outline in your findings, for example, technical data, questionnaires, letters sent, tables, sketches, charts, leaflets.

It is supplementary information which you consider to be too long or complicated or not quite relevant enough to include in your main body, but which still should be of interest to your reader.

Each appendix should be referred to in your text. You should not include something as an appendix if it is not discussed in the main body.

References

[if required]

This is a list giving the full details of all the sources to which you have made reference in the body of your report.

Bibliography

[sometimes included]

This is a list of all the sources which you have used during your research – books, articles, and web sites. It should include those you have made reference to in your writing, as well as any other materials you may have consulted but not quoted.

Glossary

[occasionally included]

A glossary contains specialist terms with their contextual definitions. This is particularly useful when specialist terms have been used in the report.

Include a glossary of terms if the report includes a lot of specialised vocabulary, technical jargon, or acronyms which may not be familiar to the reader.

© Roy Johnson 2013


More on How-To
More on literary studies
More on writing skills


Filed Under: How-to guides Tagged With: Document design, Document structure, Information design, Reports, Writing Reports, Writing skills

Planning a Dissertation

February 21, 2015 by Roy Johnson

planning, structure, headings, and creating order

Planning a dissertation – what is it?

A dissertation is a piece of academic writing normally submitted as part of a Bachelors or a Masters degree (BA or MA). In some cases the term ‘dissertation’ might be used interchangeably with thesis, which (in the UK) is normally reserved to describe work at PhD level.

A dissertation can comprise anything from 8,000-10,000 words up to as many as 20,000 words, depending on the subject, and is normally shorter than a PhD thesis. It is written to show that you can produce an original idea, engage in academic research, and follow the conventions of argument and written presentation at this level.

The main problem for most people is that they’re unlikely to have written such a long piece of work before. Dealing with large amounts of information and producing a long and coherent piece of writing isn’t an easy task. The conceptual skills required and the burden of generating so much writing can seem overwhelming. For this reason it is vital that you create a plan before you start.

Planning a dissertation

The following guidance notes give an explanation of what’s required and a template to help you make that plan. The notes are a series of headings which will help you to clarify your ideas and create the outline or structure for what you have to do. They are not a timetable and they don’t cover the reading and research work involved in producing a dissertation. That part of the process is covered under Managing a dissertation.

Use these headings to generate an outline plan before you start any serious writing. The plan can be modified or enhanced as you go along – but at any given time you will have an overview of the project. This will help you to identify (name) any writing on which you’re working and decide its relevant position within the overall scheme. It will also save you from feeling ‘lost’ amongst your notes and your research materials.

It’s helpful to create your initial writing as chunks, or parts of the whole piece, rather than conceiving of the finished object at this stage. This gives you the opportunity to work on any one chunk whenever it’s convenient for you without becoming overwhelmed.


The title

You should have at least a rough idea of what you are going to write about. The provisional title does not have to be exact, and you can change it slightly as you go along. The act of creating a title forces you to clarify in your own mind the most important elements of your project.

It’s possible to start out with a long and possibly a slightly hazy title. But as you do more work generating the dissertation, the title should become shorter and more clearly expressed. [Some science subjects might require longer titles because of the complex names of chemicals or biological processes.]

The prime importance of the title is that it should specify exactly what your dissertation is about. Its secondary purpose is to act as a reminder while you’re writing that each part of the work should be directly related to its stated purpose. Your dissertation might be –

  • an argument
  • a survey
  • an investigation
  • a project
  • an analytic study

But the title is the most succinct expression of its subject and purpose.


The summary

Many dissertations also require an abstract or summary. This is a digest or a shorter version of the work as a whole. The abstract draws out in shortened form what’s contained in the complete thesis. It might also be known as a précis or a synopsis.

This might well be one of the last things you finalise. A summary is difficult to write before you’ve produced the work as a whole. But even a provisional summary will help you to keep the overall project in mind This too can be modified and updated as your work progresses.


The introduction

As in the case of the title and summary, the introduction might be something you only finish writing after you’ve done the main work of the dissertation. After all, it’s not easy to introduce something that’s not yet been written. However, you should have some idea of how you will introduce the main body of the work. It might be something like any of the following:

  • a description of what follows
  • the historical context to the subject
  • the origins of a problem to be studied
  • a summary of recent opinions
  • a digest of current research

Once again, even if you decide to change part of the dissertation as your work progresses, it’s better – at any given point – if you have a stated intention of how you propose to introduce the main body of your work. This ‘intention’ will help you to conceptualise the work as a whole and keep its structure alive in your mind.


Literature review

If the regulations call for it, you’ll need to include a section or chapter offering a literature review. This is a survey of the recent research findings on your topic or subject. You need to show not only that you have read the latest studies, but that you are able to digest their findings and arguments.

This is something that you can quite easily work on and store separately whilst you’re working on the rest of your dissertation. The exact position of the review in your plan will be determined by the conventions of your subject. It usually precedes the methodology, and will almost certainly come before any results.


Methodology

Planning a DissertationThis is an optional section, depending on the subject of your dissertation. Subjects that involve any sort of scientific or quantitative investigation will require an account of the methods used. This account will include an explanation of how the research has been designed and implemented, and why the particular collection of data and the method of analysis has been chosen. The methodology might be qualitative, quantitative, or experimental, and it might involve gathering information and subjecting it to close scrutiny and analysis. Arts and humanities subjects tend not to have quasi-scientific methodologies, but rely on the close examination and analysis of materials and texts, followed by the your own persuasive arguments.


Structure

A dissertation is often organised into a number of parts or chapters. The subject under enquiry might suggest or determine what these parts or chapters could be. Splitting your work into separate parts will make the process of composition easier. It means that whilst working on one part, you can temporarily separate it from the others. The arrangement of these parts might be determined by –

  • chronological order
  • logical progression
  • steps in a process
  • narrative sequence
  • equal significance
  • category groupings

The following are three practical examples based on this notion of creating structure. One further advantage of following this procedure is that the total word-count for the dissertation can be (roughly) divided between these sections or chapters (plus the introduction and conclusion) to produce a well-balanced whole.

  • A historical study of economic depression in the 1930s might be split into four main chapters covering the years 1930-1933, 1934-1936, 1937-1939, and 1939-1940
  • A study of Shakespeare’s tragedies might have four separate main chapters, one each on Hamlet, Othello, King Lear, and Macbeth
  • A study of inner-city pollution might be structured by separate sections on traffic density, open green spaces, air pollution, and housing density

Conclusion

You might not know the final conclusion of your dissertation project until you finish writing, but you can fill in this section with what you think or hope it might be.

This is a very good case where the title of your dissertation might be of help. If your dissertation title includes ” … show the influence of X on the work of Y …” you know that your conclusion must discuss examples of the work of Y and should reveal instances of the influence of X.


Bibliography

Colleges and universities usually have their own house guidelines for the manner in which bibliographic information is presented. In addition to this, various subjects and disciplines follow their own conventions – or they might adopt internationally recognised systems such as the Modern Humanities Research Association (MHRA), the Harvard System, or the Modern Language Association (MLA) system for bibliographic presentation.

It’s very important that you acquaint yourself with the system used for your subject and make sure you know all the small details of referencing, citation, and the listing of sources – including references to materials on the Internet.

Fortunately, this part of the dissertation is easy to produce, because you simply add to the list of texts and secondary sources you have used as you go along. The bibliography might even be divided up into primary and secondary sources.


Planning a dissertation – related study guides

How to fail your dissertation
Comic but very useful tips on how to avoid common mistakes

How to write a thesis abstract
A tutorial on how to create a one-page summary for longer works

How to solve research problems
Study tips for recovering from common errors and bad planning

Definitions of a thesis at Wikipedia
Structure, style, and variations by country, plus web links

How to write a thesis and which software tools to use
Data management, mind maps, creating structure, and bibliographies

© Roy Johnson 2015


More on How-To
More on literary studies
More on writing skills


Filed Under: How-to guides, Study Skills, Writing Skills Tagged With: Academic writing, Document structure, Planning, Writing skills

Get in touch

info@mantex.co.uk

Content © Mantex 2016
  • About Us
  • Advertising
  • Clients
  • Contact
  • FAQ
  • Links
  • Services
  • Reviews
  • Sitemap
  • T & C’s
  • Testimonials
  • Privacy

Copyright © 2025 · Mantex

Copyright © 2025 · News Pro Theme on Genesis Framework · WordPress · Log in