Beruflich Dokumente
Kultur Dokumente
Amsterdam Diemen
REPORT WRITING
Some Guidelines
for IBMS Students
Brian Downey & Keith Medhurst School of Economics Revised 30th April 2010
(Version 18)
Cover/Title Page - IMPORTANT POINTS: Choose a title that truly represents the contents. The cover/title page should include at least: the title and, if necessary, a subtitle. Furthermore, it should show the name of the author or organisation responsible for the report. In addition you should mention: place and date of the publication, and the name of the lecturer or company for whom you have written the report. In many business reports you will find that the cover page, containing only the title and the name of the author, is a separate page from the title page. Very often it will be of a harder, protective material, than the rest of the report. For student reports it is practical (for purposes of marking) to use the combined format used here.
Hogeschool
Amsterdam Diemen
1 PREFACE:
This handbook has been compiled as an extra tool for IBMS students. To benefit optimally from the handbook, the student needs to read the appropriate chapters in any book on business communication. There are many different kinds of reports and various formats, sometimes dependent on a companys house style. This handbook provides IBMS students with a standard which should be used throughout the entire 4-year IBMS course. It can be seen as the IBMS house style. The preface should include an explanation of why and for whom you are writing the report. So you should summarize the assignment that requires you to write the report and refer to a copy of the assignment in your appendix. This information is sometimes referred to as Terms of Reference and can be taken up as a separate section of the report. If you wish to thank or acknowledge assistance you have received in putting your report together, you can either include this here in the Preface or in a separate section entitled Acknowledgements. The final paragraph of this section is an example of this: Finally, this handbook has been compiled from various sources, which are mentioned in the bibliography. We also acknowledge here that the critical suggestions and improvements offered by students and colleagues over the past few years have been invaluable in fine-tuning the handbook to what it is today.
IMPORTANT POINTS A preface should precede the actual discussion or problem. A preface is not directly related to the subject matter, but provides the reader with other relevant information. Some matters that can be dealt with in a preface: 1. information on why the report was written (project, research, traineeship). 2. background of the author, 3. description of the target group - for whom the information has been written 4. acknowledgements to people who have been beneficial in your research.
page i
Hogeschool
Amsterdam Diemen
2 TABLE OF CONTENTS
1 2 3 4 5 6 7 Preface: ........................................................................................................................................................... i Table of Contents .......................................................................................................................................... ii Executive Summary .......................................................................................................................................1 Explanation of terms and/or abbreviations: ................................................................................................2 list of charts and tables ..................................................................................................................................3 INTRODUCTION ..........................................................................................................................................4 BODY OF THE REPORT .............................................................................................................................5 7.1 Planning a professional report ..................................................................................................................5 7.2 Presentation ..............................................................................................................................................6 7.3 Plagiarism and how to avoid it .................................................................................................................7 7.3.1 How Can Students Avoid Plagiarism? .............................................................................................7 7.3.2 Plagiarism and the World Wide Web ...............................................................................................7 7.4 Use of Language .......................................................................................................................................8 7.5 Letting your Computer work for you .......................................................................................................9 7.5.1 Planning ...........................................................................................................................................9 7.5.2 Producing .........................................................................................................................................9 7.5.3 Editing ..............................................................................................................................................9 8 Conclusion: ...................................................................................................................................................10 9 Recommendations ........................................................................................................................................11 10 Bibliography .............................................................................................................................................12 11 Appendices .................................................................................................................................................. I 11.1 Appendix I An overview ...................................................................................................................... II 11.2 Appendix II - Types of reports used in business ....................................................................................III 11.2.1 Regular and routine reports ...........................................................................................................III 11.2.2 Occasional reports .........................................................................................................................III 11.2.3 Especially commissioned reports ...................................................................................................III 11.2.4 Format ............................................................................................................................................III 11.2.5 Applications....................................................................................................................................III 11.3 APPENDIX III - The short formal report .............................................................................................. IV 11.3.1 Layout ............................................................................................................................................. IV 11.3.2 Principle Components .................................................................................................................... IV 11.4 APPENDIX IV - The short informal report .......................................................................................... IV 11.4.1 Layout ............................................................................................................................................. IV 11.4.2 Principal Components .................................................................................................................... IV 11.5 APPENDIX V - Report component check list ........................................................................................ V
IMPORTANT POINTS Spread the table of contents equally over the page. Do not type the definite version until the report if finished. Page numbers may vary until then. Start numbering after the table of contents. Use the so called decimal code system for headings and sub headings. Make sure that the numbering really represents the hierarchy of the contents. Do not use more than three digits behind the decimal point. Check whether the headings in the table of contents coincide with those in the report itself. If possible, use automatic MS Word facility Insert Table of Contents Try and use short, informative headings.
page ii
Hogeschool
Amsterdam Diemen
3 EXECUTIVE SUMMARY
The relevance of report writing in the business world cannot be exaggerated. The technique of how to write a professional report is a skill that can be learned. Even if you have a natural talent for writing, only with a systematically organised presentation of the information, will your message have optimal impact. The handbook provides a summary of the essential aspects of professional report writing. It emphasizes that the writer should plan a clear and logical structure for the report, making it as easy and pleasing as possible for the reader to read. This also means that the way the information is presented and formulated should be reader-friendly. Use of simple, straightforward language is recommended, especially when the content of the report is complex. Report writers following these guidelines, along with more in-depth study of relevant chapters on any book on business communication will get their message across efficiently. Readers are reminded that writing is as much about reading and rereading as it is about writing. The more people who read and give feedback on early drafts of the final report, the more clarity and effect the finished product will have.
IMPORTANT POINTS Many readers (especially Executives!) will stop here, because they only want to be informed of the main content of the report. Others may decide whether or not to read on, depending on the content of the Executive Summary. Explain the subject or define the problem, summarize the various chapters and provide the most important conclusions. Be concise and complete, ensuring all the major points are adequately covered. Start your numeric page numbering from here.
page 1
Hogeschool
Amsterdam Diemen
IMPORTANT POINTS Keep the lay-out consistent and clear Keep the explanation concise and list things alphabetically. Use simple language.
page 2
Hogeschool
Amsterdam Diemen
IMPORTANT POINTS: Charts and tables should always be linked to the text and referred to in the text of the report. An alphabetical list of symbols or illustrations is essential when a report contains many recurring of them. The items should also be explained once in the text of the report, where they first appear.
page 3
Hogeschool
Amsterdam Diemen
6 INTRODUCTION
This guide looks at some of the challenges faced by students in producing informative and professional written reports. A number of areas are addressed, including planning, writing, and editing reports. In addition, tips are given about the use of technology / IT facilities to gain the best results. A summary of the essential aspects of professional report writing is provided in stages. First it shows you how to draw up a title/cover page, followed by a preface. Then it demonstrates a clearly structured and numbered Table of Contents, which precedes the Executive Summary. Next the sections Explanation of Terms and Visual Aids are demonstrated before reaching this section, the Introduction. The Introduction is the first numbered item in the report, followed by the Body of the Report, which contains all the chapters of the actual content and findings of the report. In this handbook the Body contains 3 main sections, namely the Planning, Presentation and Use of Language phases. Next come the Conclusions and Recommendations. Finally, there is a bibliography and an appendix. The IMPORTANT NOTES boxes on each page summarize the main points you should bear in mind for each section of the report.
IMPORTANT POINTS: The Introduction should be written after you have written the report and its conclusions and recommendations. An introduction deals with what (subject or problem), why (purpose or importance of subject or statement of problem) and how (method, approach or structure) of the report. Often, as in this report, the order is why, what and how. See to it that your problem or subject is clearly defined. Furthermore, take care that the reader is presented with an image of the basic structure of the report.
page 4
Hogeschool
Amsterdam Diemen
IMPORTANT POINTS Formulate the subject or problem accurately. Determine the purpose or scope of the subject. Familiarize yourself with your prospective audience. In other words who are you writing for and how much knowledge of the subject can you assume your reader has? Focus on the reader and give the report a reader-friendly structure. Order the chapters logically and separate major and minor issues. Anticipate questions your reader is likely to have and provide answers. In your conclusion you should link up again with the subject or problem defined in the introduction.
page 5
Hogeschool
Amsterdam Diemen
7.2 Presentation
A report that is pleasing to the eye, evenly and generously spaced is easier to read than one that has pages with too much text and no white space. Look at any modern study text book and learn from the way the information is laid out to make it easier for the reader to consume. With modern IT software there are all kinds of ways to make certain parts of the text stand out. Especially in the case of reports for lecturers, you should bear the presentation in mind. They may well devote part of their assessment to the presentation. What is certainly true, when a lecturer has a pile of say 60 reports to grade, they will appreciate reports that are professionally laid out and easy and pleasant to read. This appreciation may well, either consciously, or unconsciously, find its way into the grade you are awarded. All reports should have some kind of protective cover both at the front, i.e. the cover page, and at the back. In addition, appropriate binding should be used. When you ask fellow students to give feedback on the text of your report, ask them also to comment on the presentation. Such feedback is essential. Something you find perfectly clear or logical may not be clear or logical to a reader. Another aspect of presentation is REFERENCING. Whenever you have relied on work written by someone else, it is vital that this work is acknowledged so that the source of the idea is identified, and any discussion on the points expressed can be put into context. Such referencing also allows credit to be given to whoever came up with the idea originally, and it shows that the arguments made in the report are based on recognised secondary sources. Referencing is often done using so-called footnotes. These can be inserted into your report by using one of the MS Word Insert functions. In addition to footnotes per page, sources used should also be listed in the bibliography at the end of the report. If someone has relied on the work of others but has failed to acknowledge the source, they could be charged with plagiarism. Students are referred to the REFERENCING instructions in the Public Folders of Outlook on the school computer network, where this Report Writing Handbook can also be found. IMPORTANT POINTS: A reader-friendly layout and good use of white space are essential. Use at least 1.5 spacing between lines of text, unless otherwise specified in the assignment. See to it that your report meets all the requirements mentioned in this manual. When relevant, try to incorporate diagrams or tables or other visuals in your report. Always mention sources, either in a footnote, or in the bibliography, or both.
page 6
Hogeschool
Amsterdam Diemen
Terms you need to know: Common knowledge: facts that can be found in numerous places and are likely to be known by a lot of people. Quotation: using someone's words. When you quote, place the passage you are using in quotation marks, and document the source according to a standard documentation style. Paraphrase: using someone's ideas, but putting them in your own words. This is probably the skill you will use most when using sources in your writing. Although you use your own words to paraphrase, you must still acknowledge the source.
page 7
Hogeschool
Amsterdam Diemen
IMPORTANT POINTS: Be reader-oriented in your writing. Do not pay attention to mistakes in the first version. Get your thoughts on paper in an uninhibited way. You will probably spend more time reading, re-reading and editing than writing. Avoid long sentences and limit the use of sub-clauses. Limit the amount of information in one sentence or paragraph. Very often, you will put the essence of a paragraph in the first (key) sentence. See to it that difficult or unfamiliar terms are explained clearly. Carefully check your spelling. Have others read your report and process their feedback. Perfect punctuation before you print out your final version of the report.
page 8
Hogeschool
Amsterdam Diemen
7.5.1 Planning
Insert Section Break used to ensure that formatting features applied later on can be limited to particular sections, i.e. Front Cover, Main Body or Appendices. Insert Page Break used to make sure a new subject starts on a new page, even after text on a previous page has been added or deleted. Page set-up used to determine paper size, margins, header & footer size. Format, Font determine which letter style, size etc is to be used, and be consistent.
7.5.2 Producing
Tools, Track changes allows you to monitor editing and can be very valuable for large documents, or where different versions are in circulation. Format style used to format headings and sub-headings, guaranteeing consistent style and inclusion in the automatic table of contents. Can be used to number headings too. Edit, Find to locate a text that needs attention. Insert, Symbol to add special signs e.g. Tools, Thesaurus to find other similar words that better convey your meaning.
7.5.3 Editing
Insert page numbers use different formats for key sections. Insert Table of Contents automatic feature that copies all text formatted as one of the Header styles into a table of contents Insert Headers & Footers for a consistent & professional finish. Modify where necessary for different sections. Format, Font for special effects including colour text. Tools, Spelling & Grammar set language first, then spell check. Format, Bullets and Numbering allows for consistent and clear style in lists. Format painter icon to copy a format from 1 piece of text to another. File, Print preview allows you to see what the printed out version will look like.
page 9
Hogeschool
Amsterdam Diemen
8 CONCLUSION:
These guidelines do not claim to be anything more than a summary of the techniques of report writing. The form they are presented in should be seen and adhered to as the IBMS house style. All your reports should follow these guidelines, unless otherwise specified in the assignment. The reader is advised to study the subject of report writing in more detail in any reliable work on business communication. Successful and effective report writing is a reader-friendly combination of form and content, tightly contained in a systematically organised structure and lay-out. It is a process of planning, presentation and editing. It is the result of many readings by the author and others, in order to obtain a final text that incorporates valuable feedback. The more feedback obtained, the better the report. Report writing is as much about reading, re-reading and editing as it is about writing. It is a skill that can be learned and perfected on an on-going basis by everybody. The more reports of others that you read and give feedback on, the better your own reports will be.
IMPORTANT POINTS: Conclusions should meet three requirements: They should not be a surprise to the reader who has just read the report. In other words, the reader should be able to find the basis of the conclusions in the previous chapters. A good conclusion will never contain new elements. Just like the summary, conclusions should be clear to someone who has not read the entire report. Good conclusions are concise and compact Conclusions can be followed by recommendations. Do realize that as the writer you have to interpret the findings and draw conclusions from them. This should not be left to the reader.
page 10
Hogeschool
Amsterdam Diemen
9 RECOMMENDATIONS
1 2 3 4 Students are recommended to study these guidelines alongside more indepth chapters on the subject of report writing, to be found in any text book on business communication. Feedback from others and incorporating it into the final version of the report is an essential part of the process. Have as many people as possible give you feedback on your texts. Use these guidelines for all your reports, unless otherwise specified in the assignment. The reader is also referred to the various appendices to this handbook, which contains various general information on report writing, types of reports and check lists at the end of the handbook.
IMPORTANT POINTS: This is where you can detail any recommendations that you have for the reader. This is the section in which you give your personal recommendations based on the research you have done and the findings you have come up with. It will be clear to the reader that these are subjective, rather than objective. Whether or not the reader follows up your recommendation, that is the readers own decision.
page 11
Hogeschool
Amsterdam Diemen
10 BIBLIOGRAPHY
Bovee & Thill, Business Communication Today, 3rd ed., McGrawHill Inc., New York, 1992. Murphy et. al., Effective Business Communications, International edition, 7th edition, McGraw Hill, U.S.A., 1997. Hoogland Wim, The Report on Report writing, Wolters Noordhof, Groningen, 1992 Stanton Nicki, Communication, 2nd ed., Macmillan, London.
IMPORTANT POINTS: - A bibliography is an alphabetical list of books or articles consulted. - For a book: first the authors name and initials (no personal titles), other authors initials and names, full title of the book underlined; edition (if it is not the first), publisher, place and year published. When there is more than one author, you can also name the first ones surname followed by et. al. (see example) - For an article: first authors name (etc.), full title (in quotation marks). Name of the periodical underlined, volume, publisher, year, page numbers. - For report: authors name (etc.), full title (etc.), place, year, name of publisher, institution or company. - For a website: website address, author, title of article, page number. (Note, it is sometimes a requirement to include a hard copy of the websites used in your report, and is always advisable when using material that might not still be accessible when the report is being read.)
page 12
Hogeschool
Amsterdam Diemen
11 APPENDICES
I II III IV Guidelines on Report writing Types of Reports Short formal and informal reports Checklists
Appendix -
The purpose of an appendix is to keep the body of the report clear, concise and readable. An appendix can contain detailed calculations, information about equipment, listings, blue prints or corporate information. The report should be clear in itself, even without the appendix. Do not force your reader to leaf backwards and forwards all the time. Refer to each appendix in the text of the report. Label appendices and name them in the table of contents. If there are quite a few of them, start the appendix section with a separate table of contents.
page I
Hogeschool
Amsterdam Diemen
page II
Hogeschool
Amsterdam Diemen
11.2.4 Format
The format of reports varies considerably. Some may run to hundreds of pages, such as those produced by Royal commissions, others may be quite short and set-out on an A4 memorandum sheet. Some may be produced as succession of paragraphs of continuous prose, while others may be displayed under a series of headings and sub-headings with lists, tables and diagrams.
11.2.5 Applications
Message in letters or memoranda Oral briefings or reporting back Minutes of meetings Routine check-list reports Progress reports architect site meetings Annual reports to shareholders Profiles of candidates for interview Sales reports Newspaper reports/news releases Technical reports Balance sheets for annual audit Statistics in various visual formats.
page III
Hogeschool
Amsterdam Diemen
11.3.1 Layout
Sectionalised with schematic organisation and referencing.
11.4.1 Layout
Usually three-part and less elaborately schematic in its organisation:
2 3
Recommendations can be included under the conclusions section, or in a separate recommendations section.
page IV
Hogeschool
Amsterdam Diemen
page V