coventry university faculty of engineering and … · coventry university faculty of engineering...

12
1 MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS 2017 Ver 7.0 COVENTRY UNIVERSITY FACULTY OF ENGINEERING AND COMPUTING REPORT WRITING GUIDE FOR ENGINEERS Developed by School of School of Mechanical, Aerospace & Automotive Engineering 2017 Compiled by Martin Lander Contributions from Kirsty Kift Geoff Booth Glenn Miles Tim Gillam Date Version Number November 2010 1.0 November 2011 2.0 November 2012 3.0 January 2013 4.0 April 2013 5.0 December 2015 6.0 January 2017 7.0 ©Coventry University Coventry University, Priory St, Coventry, CV1 5FB

Upload: lethu

Post on 10-Apr-2018

216 views

Category:

Documents


3 download

TRANSCRIPT

1

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

COVENTRY UNIVERSITY

FACULTY OF ENGINEERING AND COMPUTING

REPORT WRITING GUIDE FOR ENGINEERS

Developed by

School of School of Mechanical, Aerospace & Automotive Engineering 2017

Compiled by Martin Lander Contributions from Kirsty Kift

Geoff Booth Glenn Miles Tim Gillam

Date Version Number

November 2010 1.0

November 2011 2.0

November 2012 3.0 January 2013 4.0

April 2013 5.0

December 2015 6.0

January 2017 7.0

©Coventry University

Coventry University, Priory St, Coventry, CV1 5FB

2

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

ABSTRACT / SUMMARY This guide is to assist in compiling a technical report. This document SHOULD NOT be used as a single source of information to write a technical report. It is not designed to prepare students for industry as a stand-alone document, simply to lead students in the correct direction such that they can begin to research their own study skill techniques. It aims to provide a brief overview of the formatting required but is by no means extensive and should be supplemented by THE STUDENT’S OWN investigations into research and study skills. Remember that report writing takes time and practice. At the end of the guide are a list of suggestions on where to find examples and literature to further develop knowledge and understanding. Many students reports are let down simply from POOR FORMATTING AND STRUCTURE, pay attention to Page 9 of this guide for simple tips to avoid this. You control MS Word, not the other way round.

For a thorough explanation of how to structure a report to industry standard please use the library catalogue (locate.coventry.ac.uk) to find BS 4811:1972 ‘The presentation of research and development reports’.

Generally a technical report should follow the structure below;

Title page and Declaration

Abstract / Summary

Contents, List of Figures and Tables

Introduction

Project Time Management Projection Gantt Chart (necessary on larger scale projects)

Current Research in area of project (Theory)

Experimental procedure and results

Discussion

Conclusions and Recommendations

Acknowledgements

List of References

Appendices o Tables o Illustrations (those not included in the main body of text, generally raw data) o Graphs o Complete Literature Survey

Bibliography

Glossary

List of abbreviations, signs and symbols

Index

Distribution list

Document control sheet

Abstract card (s)

Back cover

(to be included only in comprehensive

reports such as dissertations or if document

is to be in accordance BS4811:1972)

The titles and sections above are presented for guidance only. The order of items and those to be included vary dependent on which source text the student uses for research. Students are encouraged to complete their own research on the presentation of research reports and to use their own judgement of what is relevant based on their own study skills research. Published examples may be uncovered through the course of study.

The purpose of an academic report is compile information for somebody else to read, ie The Reader. The very nature of academia means there are always questions arising. The writer should be aware that the reader will be expecting them to continue the study after the writer completes it, therefore all supporting and supplementary data should be traceable and needs to be available to support these discussions. Being prescriptive in the requirement means that the writer gauges that "cost" of the report better and is prepared to support any additional queries arising. Writers then, need to have a reserve of information which would find itself typically in a well-maintained and detailed logbook.

3

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

CONTENTS

ABSTRACT / SUMMARY .......................................................................................................................................... 2

List of Figures and Tables ........................................................................................................................................ 3

INTRODUCTION ...................................................................................................................................................... 4

WRITING A REPORT ................................................................................................................................................ 4

Aims and Objectives ............................................................................................................................................... 4

Structure ............................................................................................................................................................. 5

Structure (Details) ............................................................................................................................................... 5

GENERAL WRITING STYLE ....................................................................................................................................... 9

Format ............................................................................................................................................................ 9

Presentation and aesthetics ......................................................................................................................... 10

CONCLUSION ........................................................................................................................................................ 10

RECOMMENDATIONS ........................................................................................................................................... 10

LIST OF REFERENCES ............................................................................................................................................. 11

APPENDIX A – SAMPLE TITLE PAGE ...................................................................................................................... 12

LIST OF FIGURES AND TABLES

Table 1 – Objectives; Good and Bad ….………………………………………………………..…………………………………………………….3 Table 2 - Paragraph Technique……………….………………………………………………………………………………………………………….5

4

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

INTRODUCTION Take time to read and understand the following. During their career a professional engineer will be required to compile reports to document a variety of exercises and investigations. This guide has been written to help students gain knowledge of how to structure or format the content a report. It is not to be cited as a single source of information. Importantly, it does not contain detailed guidance on how a student should use the information they have gathered and use it to prove or disprove the hypothesis they set out to investigate. This guide should be supplemented with their own research into study and research skills. It is very important for academic success that a report is correctly constructed, the content requires independent study which may take some time to perfect. When writing a report in a team situation or in a business scenario it often needs to go through a review cycle more than once. This can add time to and can often mean hastily published, error-filled reports, which may be avoided through practice. In the real world, time is money.

WRITING A REPORT

AIMS AND OBJECTIVES Before beginning the report, take some time to consider the stages below. Make a statement about each one in a logbook and always keep them handy in case of loss of focus in writing the report.

STAGE 1 - WRITE THE REPORT’S AIMS AND OBJECTIVES

Aims and objectives describe the report’s purpose, there should be approximately five. The objectives should be specific so that on completion they can be considered in the conclusion and ticked off. For example;

Good Bad Specific Measurable Achievable Realistic Timebound (Research and understand SMART objectives)

Investigate battery technology and limitations of performance due to cold weather in relation to small vehicles.

Investigate battery technology and limitation of performance.

Table 1 – Objectives; Good and Bad

STAGE 2 - INVESTIGATION - COLLECT FACTS

This is the content that will be needed to develop the discussion. Gathering relevant information can be a time consuming task in any assignment, ensure you give it the time it requires. As topics are researched make a note of every source used or referenced to save having to find it later. This maybe library books, research papers, leaflets, lectures and where appropriate material sourced from the internet. Projects must demonstrate a keen awareness of relevant existing knowledge with all used material must be properly referenced. The project may sometimes require a Literature Review of current research on the subject being investigated. See the Document “Literature Review for Engineers” for more information on this.

STAGE 3 - ORGANISATION AND SELECTION OF INFORMATION

Read through the information and note the main points relevant to the aims and objectives. Discard irrelevant and unnecessary material. Don't include material just because it is interesting, it must be relevant. A thinner focussed report is much preferable and easier for the writer to keep focus. It is often helpful to separate the subject areas being covered to place information under the appropriate heading in a similar fashion to the matrix style in the Literature Review guide.

STAGE 4 - STRUCTURE THE REPORT AND ORDER THE MATERIAL

Think about what information goes where and begin to sort it into relevant fields. Research reports can relate to obscure information. The need to capably inform the reader is essential, the report writer must take on the role of teacher when considering what to include and write at a level such that “an adequately skilled worker in the field [can] retrace the steps of the investigation without undue difficulty” (BS4811: 1972).

STAGE 5 - CONTINUALLY REFER TO YOUR AIMS AND OBJECTIVES

This will help you focus on what is relevant.

5

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

STRUCTURE There is no fixed format for a report's structure, the following has been taken from BS4811: 1972. Other report structures are perfectly acceptable, but this is the guidance from industry.

Title page and Declaration

Abstract / Summary

Contents, List of Figures and Tables

Aims and Objectives

Introduction

Project Time Management Projection Gantt Chart (necessary on larger scale projects)

Current Research in area of project (Theory)

Experimental procedure and results

Discussion

Conclusions and Recommendations

Acknowledgements

List of References

Appendices o Tables o Illustrations (those not included in the main body of text, generally raw data) o Graphs o Complete Literature Survey

Bibliography Glossary

List of abbreviations, signs and symbols

Index

Distribution list

Document control sheet

Abstract card (s)

Back cover

STRUCTURE (DETAILS)

(to be included only in comprehensive

reports such as dissertations or if document

is to be in accordance BS4811:1972)

Title page and Declaration A title page for the report should contain; 1) unique identification number and version control number 2) secondary report number, (if required) 3) title and sub-title, (if required) 4) declaration 5) author’s name 6) date

These are the minimum required for reports while at university, however BS4811:1972 offers guidance on other titles. Use ordinary English grammar, and avoid making it ambiguous; for example, a good title might be “An analysis of wishbone performance using CATIA FEA”. A poor example of the same project would be “CATIA analysis of Wishbone. Appendix A contains an example format. Reports need unique identification numbers for the purposes of traceability. A version control number is essential if they relate to the development of software code, which should also be under version control. It is desirable to maintain a history of changes to explain what has changed since the last issue, this should be kept in a well-ordered logbook or as an appendix. The declaration should be signed.

Abstract / Summary “The writing of the summary is one of the most important tasks particular attention should be paid to it”, (BS4811 1972). Written retrospectively, this is short description of everything that happened in the course writing the report.

6

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

Reports are READ by three types of people; 1. Someone busy, who needs to know the important outcomes. 2. Someone interested, who is expecting flowing narrative to assist in their wider reading of the topic. 3. Someone seeking a specific piece of information in the report, who needs to be able to find it quickly.

It's clear that a busy reader needs a summary. Someone interested wants to assimilate information in an unbroken flow and a seeker will want to locate items without reading the whole text. The writer’s job therefore is to write an abstract that must assist all of these people and contain the information in a format to do so. For a short report, approximately 150-200 words is enough. Final year projects maybe one page.

Contents, List of Figures and Tables Section title, sub-title (where necessary) and page number, listed verbatim. Take time to learn to use Microsoft Word correctly, the ‘Styles’ function can be used to compile a contents page. Include a list of numbered images and graphs into the contents page, just like at the beginning of this guide (BS4811: 1972).

Aims and Objectives These should be focussed objectives based on the title or hypothesis of project report, the overall aim of the report is to prove or disprove this hypothesis. In many instances students deliver investigations where they have failed to prove or disprove anything; achieved simply through failing to critically analyse the objective of the task due to poor time planning, mis-understanding the importance of experimentation and gathering of data, and through lack of desire to study the area properly. Goldratt’s ‘student syndrome’ suggests that too much emphasis is given to completing a piece of work too close to the deadline to obtain pass a mark, rather than correct engagement with the subject matter to learn about the area more fully. Failure to engage reduces the writing of reports into exercises in completeness, and will result in a justifiably poor mark. The aims and objectives will later form the basis of the conclusion where students are required to comment on if they have proved the project to be a success or a failure, dependent on the statement of the hypothesis.

Introduction The introduction brings the reader to the point of understanding of what will follow in the report, containing a succinct explanation of the aims and objectives and the reason the report has been produced/commissioned. It should clearly describe why the report exists as a body of work made to expand on an existing subject area, rather than simply a paperwork exercise for a student to pass a degree. It shows the relevancy of the project within the greater context of engineering and how it will develop that area of research to help in others’ wider reading and research (remember the ‘interested reader’ highlighted above in the Abstract/Summary section). It should not anticipate what is to be expected but should comment on the broader outcomes and achievements based on the aims and objectives and what the student aims to find, thus leading the reader to understand what to expect from the subsequent report. A common problem is how much background information to include. It should introduce the salient features of the work and set the report within the context of its research area. It should not include;

o Erroneous and irrelevant research. (If the project is investigating aerodynamics of modern pushbikes, details such as the inventor of the pneumatic tyre and the first recorded metal constructed pushbikes aren’t relevant details; interesting, but irrelevant).

o Details of experimental procedure. o Discussion of results. o Simply repeat the summary. Or vice versa, the Summary should not have been written yet!

Project Time Management Projection Gantt Chart It’s imperative to complete the project on time, especially when a late hand in receives a mark of 0%. No arguments. Consider this a warning! Use methods such as a Gantt Chart to help manage time effectively. There’s a saying, “Proper Planning Prevents Poor Performance”. As clichéd as it is, it is true. See the MAE Design Model online for detailed guidance on Gantt Charts. Many students do not plan projects properly and inflate time scales, failing to properly engage with the project until they feel it’s appropriate to begin the task around their other commitments, see Goldratt’s ‘student syndrome. Students are encouraged update the time plan throughout the project to allow them to reflect on how the project is progressing, and how they must reassess the remaining time to complete the remainder of the project. A Gantt chart is not written in order to obtain extra marks for the marker, it should be written by the student for them to assess their own progression. Students are also encouraged to submit a timing plan after the project has completed and

7

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

compare this with their original, this ‘reflective practice’ allows the student to learn from their own mistakes, failures or poor planning to improve their performance next time.

Current Research in Area of Project (Theory) In some instances this maybe called a Literature Review (See the Document “Literature Review for Engineers” for more information on this). On smaller projects, demonstrate awareness of the preceding research areas within the context of the project being undertaken as there are many people conducting research in the same area; What have they done? Can their research be supplemented? For example if a student is asked to ‘investigate the power losses in an electric wheelchair propulsion system’, their first exercise is generally to search the web for the title of the project. Upon finding nothing that matches exactly they will generally make the statement “I can’t find any research in this subject area as I can’t find anything on Google, what should I do?”. This will generally illicit a terse response from a supervisor suggesting that there is a great deal of research, they just need to review their research methods. A very good starting place, might be to consider the component parts of an electric wheelchair (electric motors have existed for a great many years, as have gel batteries) and use the university library to find published work on those specific components. Include research from current engineering journals and magazines (Industrial Technology, New Scientist). Do not assume using Google or Wikipedia is a single valid form of research, many internet sources are unreferenced and unreliable. Academic research should be conducted using many sources of information. The university library is the single most important tool in any research project. Half a million books are a good start point for any project. Using web searches maybe quicker, but spending one day gaining a fundamental understanding of a research area through publications contained within the library will benefit far greater than a few minutes spent searching unreferenced and unsupported statements from the wealth of erroneous data contained on the web. When a good fundamental understanding has been established, then return to the web to locate contemporary journals, texts and research in that subject area.

Experimental procedure and results If the project includes experimentation, this is the area to document how it was completed. If surveys are necessary state here the purpose and intention. Always, include evidence of experiments, most people have a camera phone these days. Always document experiments. Raw data from results should go in the Appendices, discussion on results should go in the Discussion section. Emphasis should be given to anything new. Give only simplified detail description of apparatus and techniques, greater detail may be covered in the appendix and referenced within this section.

Discussion Discuss the information presented, do not introduce any new information here. The discussion analyses the results of the work in a scientific and critical manner. Make points in turn based on evidence, developing the argument, prior to reaching one or more conclusions. It is intended to inform the reader of the project’s purpose and consider the arguements that support or disprove the hypothesis and that whatever the conclusion, it is based on balanced evidence and fact that is correct. It must be logical by staying objective based on the evidence, not subjective; confine the persuasion to proven fact and resist the temptation to indulge in personal views. Paragraph construction should be based on the PEE principle of Point, Evidence, Explanation, it’s a method an English Literature student will use to construct an argument in their essays. See Kelly Nicholls’ Youtube video for an excellent explanation of this technique (referenced below);

Point > Evidence > Explanation Aluminium framed bicycles tend to have larger diameter and thicker tubing than steel framed models.

Kalpakjian (2001:58) discusses this in his chapter in properties of solid materials.

The material properties of steel are much stiffer than that of aluminium requiring less steel to achieve the same result.

Table 2 - Paragraph Technique

This is also the section to relate back to Current Research or a Literature Review to support the argument. Often the work of others will back up the report’s focus , sometimes it disputes them, sometimes it may even highlight errors in research. It is not enough simply to present a graph or table. Always discuss the main facts are and how they relate to the subject the report being presented.

8

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

Conclusions The conclusions state what the project has achieved. The most important aspect here is to look back at the aims and objectives and comment on whether they have been achieved; after all they were the purpose for undertaking the project. By this point the writer should have gathered enough information or data to prove or disprove the aims and objectives of the project. The reader is far more likely to respect the report if the writer forms a valid conclusion rather than try to cover them up which ultimately eschews confidence in the writer. People learn through making mistakes but they must be able to develop from them as a result. Students should learn to reflect on their previous experiences through university where they have the time to develop, as when they graduate the effort required to compile a wonderfully written report that is a fallback strategy as a cover for documenting a total failure is unlikely to be received well by their colleagues and ultimately leads to a waste of time. Time in the real world costs money. It took Dr Alex Moulton ten years to develop a suspension that was eventually used on the Austin Mini, trial and error may sometimes be the only way but they ultimately come at a great cost.

Conclusions could be simple factual statements, or they could be further syllogistic arguments based on the discussion and leading to a conclusion. Some may prefer syllogistic reasoning in the discussion making the conclusion simply a concise finish to the project. Syllogistic reasoning is a well-documented topic and students are encouraged to conduct their own research into this area. Human nature defaults to seeing what we want to believe which leads to a lack of correct reasoning and questioning of the fact, in many instances illiciting statements such as “the project was a resounding success as it proved exactly the original hypothesis without any problem or disruption”. Often this assumed incontestable proof is simply the human cognitive bias to deny what has been reported as it wasn’t the anticipated result and jump to an invalid conclusion rather than work in an evidence-based manner to form a legitimate conclusion based on fact.

Recommendations If they are necessary, they should follow on logically from the conclusions and should cover; The writer’s own understanding; The limitations of the project; How the research project may be continued. As stated previously this document has been written to expand the knowledgebase in a specific research area and develop others’ wider reading and understanding. In compiling the report the writer will have referenced many texts (hopefully) in the expectation that their report will also be used to assist in developing that research area, and a reader may retrace the steps of the investigation without undue difficulty.

Acknowledgements Not necessary on short courseworks. At their discretion the writer may want to thank assistance from major contributors or sponsors. Minor assistance and general advice should not be included.

List of References Directly referenced in the text, following the CU Harvard style, linked through all Moodle Modules.

Appendices Information and documents that may overload the original discussion. Tables, British Standards, graphs, data, images, drawings, completed questionnaires. The appendix should also have its own contents and major parts should be split up into Appendix A, Appendix B…etc. The Complete Literature Survey should also be contained here (different from the literature review), it is the unrefined and crude collection of raw data and research that will have been used to pare down to construct the literature review.

Bibliography

Glossary

List of abbreviations, signs and symbols

Index

Distribution list

Document control sheet

Abstract card (s)

Back cover

Further details of these End Matter elements should be researched from BS4811:1972 and discretion used as to the validity of their inclusion.

9

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

GENERAL WRITING STYLE The style of writing should be formal and precise and avoid being convoluted. Every statement must be justified, and nothing that is written should be vague. When reading a fiction book, the reader is not asked to flick from page to page in order to understand the plot, the author takes great care to ensure this, it is what separates someone that writes a good story from a great author. The same care and attention to the development of narrative should be taken in to develop the arguments of a technical report. If the reader must exert themselves simply to understand the narrative as well as understand the technical aspects contained therein, it’s unlikely to yield a good response.

Report should be written in third person. For example, ‘this was carried out’ should be used rather than ‘I did this’. This Report Writing Guide doesn’t contain the words ‘I’, ‘me’, ‘you’ or ‘we’, anywhere. It takes practice but is made easier in time. Other main points are;

Do not use clichés or colloquialisms (look in a dictionary for the meaning of these words)

Do not make unproven statements

Spell check doesn’t recognise grammatical errors, ask someone to proof read it

However make sure Spell check is set to English UK (recognize = US, recognise = UK)

The importance of the quality and clarity of the report’s presentation cannot be over-emphasised. Students are referred to library section 808.066 for guidance. Several hundred books on English grammar, technical writing and presentation skills can be found there or in the local bookshops and libraries. Modern examples are the books by Cutts (1995), Eastwood (1994), Jay (1995), Parker (1994), BS4811:1972 and BS5605:1990. Parker is worth a particular mention because it covers a wide range of topics, is concise and very cheap. There are also publications dealing with the project as a whole from the planning stage to the final reporting.

Be particularly careful of sections the author considers to be well written; they are probably too wordy, use only words which have the precise meaning to convey the intended message.

Tables, diagrams and equations, irrespective of their source should always be numbered and given a simple title. This allows reference to them in the text and allows the reader a chance to familiarise themselves with the image to try and understand the text better.

Numbering a report using the method described in (BS 5848: 1980). Main sections are numbered 1, 2, 3 etc., with each sub-section given a decimal subdivision.

CU Harvard Referencing Style should be used throughout. This is probably the most important element of the entire report. It is very important to understand this is in order to avoid plagiarism. A guide to this is included in every Moodle page web, take time to learn this thoroughly.

FORMAT

Font should be consistent throughout, with the only exception of headings. It should be; o Same colour throughout (black, including headings) o Same font – Headings and Body - Calibri, Verdana, Time New Roman, Arial or Tahoma

Page numbers should be inserted at the top centre of each sheet.

Reports should be word processed where necessary A4 paper in portrait orientation.

A3 or large drawings should be folded in accordance to BS8888.

Headings should Bold (Heading 1, Size 14; Head 2+ Size 13)

Body text and headings should be left aligned throughout

Font size 11 Spaced, 1.5 line spacing

Margins o top ≥25mm o bottom ≥25mm o left 25mm (45mm if binding) o right 25mm

10

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

PRESENTATION AND AESTHETICS

Students are encouraged to consider the presentation of the document, use this as an example. Great care has been taken to ensure it fits onto 12 pages. Lists and/or title do not start at the bottom of one page and finish on the next. There are no unnecessary large sections of blank pages. All margins and bullet points are of the same format, same suitable font and the same size. Formatting of titles, dates and unit information is consistent throughout. Bullet points all have full-stops at the end, not a mix of some with and some without. Images and tables are not hanging off the edge of the page such that only half of them are visible. All tables and images are easy to understand and presented clearly and legibly in the same style within the flow of the text to support the flow of the text. They have not used Microsoft Office’s tables generator with pretty colours and alternatives fonts that ultimately take longer to present the information (often poorly) than a simple table or text box. Figures, tables and diagrams should be used wherever appropriate, and always referenced where they have not been generated by the writer. They should not disrupt the flow of narrative and care should be taken to avoid the reader having to constantly move back and forth through the document to find them. All tables and images should be produced using Microsoft Office or a third party vector drawing package (Inkscape, Adobe Illustrator, Adobe Photoshop), third party freeware is very easy to locate and learn to use in Y1 when students have time to spare rather than Y3 when they don’t. Any referenced images have been scanned into the computer, not a poor photo using a smart phone that is unreadable, poorly positioned, skewed, poorly contrasted and poorly represented. Included within the folder where this document is found are a collection of suitably presented, published papers from people within this university. These maybe in different formatting styles from those described above, this is because the publication in which they were printed prescribed a specific style, in the same manner this document is prescribing a specific manner to it readers. Specific phrases and words have been highlighted in bold help them stand out, this should be avoided in technical reports and is used here purely due to the nature of this report. If used, ensure they are consistent ie they are all lowercase bold, or all capitalised bold, or not bold at all, or italicised, or italicised bold. Whatever the writer chooses ensure they are consistent.

Read the included examples and learn these skills both through observation, reflection and understanding as well as instruction and (the university’s) education.

Definition of student noun a person who is studying at a university or other place of higher education: Origin: late Middle English: from Latin student- 'applying oneself to', from the verb studere, related to studium 'painstaking application'

CONCLUSION

(Concise Oxford English Dictionary 2008)

Taking time to set out a technical report in a structured and logical manner may take some practice, but the technique has grown up because writing in this controlled way helps both the writer and the reader. Using a recognised structure helps to create and present a professional report and give the writer the credit they deserve by presenting it in a suitable manner.

RECOMMENDATIONS Does the report have clearly stated aims and objectives?

Have they been achieved?

Is the reader quickly told what the report is about?

Is the material clear, accurate and well presented?

Have appropriate opportunities to make recommendations been taken?

Is the report worth reading?

These are the basics rules to adhere to. There are many places throughout an engineer’s career where they’ll be required to view published reports and documents, take note how they present information and learn from them by example. Again, read the included examples and learn these skills both through observation, reflection and understanding as well as instruction and (the university’s) education.

11

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2017 – Ver 7.0

LIST OF REFERENCES

British Standards Institution (1989) References to published materials. BS1629:1989. Milton Keynes: British Standards Institution

British Standards Institution (1990) Citing and referencing published material. BS5605:1990. Milton Keynes: British Standards Institution

British Standards Institution (1972) The presentation of research and development reports. BS4811:1972. Milton Keynes: British Standards Institution

Booth, G. (2009) Report Writing. Unpublished Booklet: Coventry University

Cutts, M. (1995) The Plain English guide. Oxford: Oxford University Press

Eastwood, J. (1994) Oxford Guide to English grammar. Oxford: Oxford University Press

Jay,A., Jay, R. (1996) Effective Presentation. London: Pitman Publishing

Jay, R. (1995) How to Write Proposals and Reports That Get Results. London: Pitman Publishing

Luck, M. (1999) Your student research project. Farnham: Gower Publishing

Owen, S. (2009) Report Writing. Unpublished Booklet: Coventry University

Oxford Dictionaries (2008) Concise Oxford English Dictionary. 11th edn. Oxford: Oxford University PPress

Parker, D. (1994) Tackling coursework: assignments, projects, reports and presentations. Coventry: DP Publications

Payne, L. (2007) Report Writing. Standards and Guidance V4.1. Unpublished Booklet: Coventry University

Payne, L. (2010) Report Writing. Standards and Guidance V5.1. [online] available from <http://www.coventry.ac.uk/swift/~csx067/rept_wrt/index.html> [24 November 2010]

Rudd, D. (2005) REPORT WRITING a guide to organisation and style. Unpublished Booklet: University of Bolton

Wood, G. (2010) Constructing an Engineering Thesis. Unpublished Booklet: Coventry University

APPENDIX A – SAMPLE TITLE PAGE 12

(IDENTIFICATION NUMBER) (VERSION CONTROL NUMBER)

(SECONDARY IDENTIFICATION NUMBER)

(TITLE OF THE REPORT)

(SUB-TITLE OF THE REPORT)

(AUTHOR’S NAME) Note: Calibri, Size 14 font

(SUPERVISOR’S NAME)

FACULTY OF ENGINEERING AND COMPUTING COVENTRY UNIVERSITY

SUBMITTED IN PARTIAL FULFILMENT OF THE REQUIREMENTS FOR THE DEGREE OF BACHELOR OF ENGINEERING

DECLARATION THE WORK DESCRIBED IN THIS REPORT IS THE RESULT OF MY OWN INVESTIGATIONS. ALL SECTIONS OF THE TEXT AND RESULTS THAT HAVE BEEN OBTAINED FROM OTHER WORK ARE FULLY REFERENCED. I UNDERSTAND THAT CHEATING AND PLAGIARISM CONSTITUTE A BREACH OF UNIVERSITY REGULATIONS AND WILL BE DEALT WITH ACCORDINGLY. )

SIGNED………………………………………………………………………………

(MONTH AND YEAR)

MARTIN LANDER - REPORT WRITING GUIDE FOR ENGINEERS – 2015 – Ver 6.0