Workshop report writting
qyfooty
guide_on_writing_report.pdf
A Student’s Guide to Report Writing
INTRODUCTION This report provides information on proper writing for report-format for D0933- Manage Project
Quality. It will address distinct components and styles of a report. It will also discuss citations
and the proper use of visual aids at the end of your report.
REPORT CONTENTS
The contents of the report should appear in this sequence below
1. Cover Page: See appendix A 2. Activities Sheets: To be filled by each project member and it must be hand written. (See
appendix B). Each member has to fill a separate sheet.
3. Table of Contents: See appendix C 4. Abstract: It is a short review of this report (max 1 page). It briefly describes the project,
methods used to perform the project, results and a conclusion. The reader should
understand what is intended in the report from reading this part.
5. Chapters: See appendix D. The report should contain chapters as shown below:
Project Definition
Initiation phase
Planning phase
Execution phase
Closure phase
Conclusion 6. Reference: See appendix E 7. Report Marking Scheme: See appendix F 8. Project Marking Scheme: See appendix G1 9. Oral Exam Marking Scheme: See appendix G2
FORMAT Report format is very similar to memo format. A standard report is written in:
1. Headings: Upper Case, 14-point Times New Roman font –Bold 2. Subheadings: Lower case, 12-point Times New Roman font –Bold 3. Paragraph body: 12-point Times New Roman font 4. Double-spaced text 5. One-inch margins on all sides.
Cover Page and Table of Contents Reports use a cover page to introduce the topic to the reader (as illustrated in this document and in
Appendix A). If the report is a long document (10+ pages), you should create a table of contents
page (see Appendix C). A table of contents page helps the reader identify and access different topics
in the report. You should have page numbers on each of the report pages except the cover page; it’s
also best to include the number of total pages so the reader knows the document’s length (i.e., Page 2
of 5). Automatic page numbering should be easy to establish through your writing program (i.e.,
Microsoft Word).
Direct Quotes/Citations/ References If you include direct quotes or ideas and information in your report that is exclusive to someone
else, you need appropriate documentation within the report and citation information. See
appendix D
In-class information: If you receive information in class via lecture, PowerPoint, case write-
ups, or textbooks, you do not have to formally cite the information. If you pull sentences directly
from these areas, however, you need to use quotation marks to show that these are someone
else’s words/ideas.
Outside information: If you retrieve information through an outside source that your professor
did not directly provide (i.e., a 10-k report on a company’s web site), you need to cite the
information. If you directly quote information, you need to use quotation marks. You can use any
proper citation style (MLA, APA, Chicago, footnotes), but you must use it consistently
throughout the document.
NOTE: IF you do not properly cite/quote someone else’s written work, it is
considered plagiarism. See the ACK for the policies, regulations, and discipline procedures for plagiarism.
Visual Aids Visual aids can include tables, graphs, exhibits, and appendices. All visual aids should have a
professional appearance. In addition, you should place your charts/diagrams embedded in your
body text of the report.
Appendix A:
Australian College of Kuwait
Department of Petroleum Engineering
PROJECT TITLE
By
STUDENTS’ NAME ID SIGNATURE
COURSE CODE & NAME
GROUP
DATE
Lecturer’s Name
Appendix B:
Activities Sheet
Name of student:________________________________________
Student’s ID:___________________________________________
Course Code:___________________________________________
Group:________________________________________________
Activities Performed Date
Started
Date
Accomplished
Remarks
Appendix C:
The style of the table of contents should be as shown below:
Table of Contents (EXAMPLE)
Introduction………………………………………………………….....Page 2
Format Pages…………………………………………………………...Page 2
Cover Page and Table of Contents………………………………...…..Page 2
Direct Quotes/Citations ……………………………………………..…Page 3
In-class information
Outside information
Visual Aids …………………………………………….....................…Page 3
Conclusion …………………………………………….....................…Page 3
References……………………………………………......................…Page 3
Appendix A: Proper Cover page format Page 4 …………… ………Page 3
Appendix D:
1. Project Definition This chapter should include information about:
Scope (see lecture notes: you must write a clear scope statement for the project)
Need and desire for the project
The project described as an opportunity
Sponsors and project funders
Project’s Users
Detailed explanation for project’s stakeholders
2. Initiation phase This chapter should include information about:
Initial Concept of the project
Projects Objectives
Project’s requirements
Project’s limitations
3. Planning phase This chapter should include information about:
Work Breakdown Structure-WBS which includes all the steps needed to do the project from A to Z.
Project timeframe and cost (show the budget and how it is allocated in detailed step by
step list. Items offered by workshop don’t need to be listed)
Risk assessment. What are the risks involved and how are they managed?
4. Execution phase
Discover and design
Build and develop
Meeting minutes and meeting agendas
5. Closure phase
Objects achieved
Deliverables delivered
Benefits realized
6. Conclusion Your report needs to be concise and straight forward; you should follow appropriate formatting
rules and guidelines unless otherwise instructed. You also should adhere to proper English
grammar at all times. If you consider the above information when writing reports, you will
construct a clear, well-written document that pleases both you and your reader. If you have
questions, please feel free to contact your instructor.
Appendix E:
Referencing in the Paper (in-text)
End of Sentence (or end of figure caption)
Examples:
Work with one author: (Jones 1987)
Work with two authors: (Reep & Bonde 2006)
Work with more than two authors: (Runge et al. 2004)
Beginning of Sentence
Examples: Michaels (2007) reported that……
Middle of Sentence
Examples: After studying the data Broadman (2001) concluded…..
Quote: Block Quotations
Examples: Hearn (2002) stated that
Pictures
Examples: The caption for a picture should include credit to the person who took the picture,
e.g. (Samuel Doalman 2008).
Figure: If you borrow a figure from somewhere, you need to use the guidelines in In Text Citations for “end of sentence,” putting the credit at the end of the figure caption and including it
in the Literature Cited with the page number. If publishing an article, it is recommended you
request permission to use another author's figure in your publication.
Reference List: At the end of report for each citation
Sterne, Jim. 2002. Web Metrics: Proven Methods for Measuring Web Site Success. New York:
Wiley.
Appendix F:
Australian College of Kuwait
Department of Mechanical Engineering
Team Report Marking Scheme
Total Weightage (30%)
Criteria Maximum Mark Achieved Mark Cover Page
4
Table of content
4
Abstract
10
Project definition
12
Initiation phase
10
Planning phase
10
Execution phase
10
Closure phase
10
Conclusion
10
Reference
10
Formatting and Styles
10
Total Marks 100
Note: Each individual should clearly show through the Activities Sheet (appendix B) how
her/his activities are related to the Manufacturing of the Project and also which parts of the Team
Report.
Appendix G1:
Australian College of Kuwait
Department of Mechanical Engineering
Project Marking Scheme (Rolling Walker Project)
Total Weightage (40%)
Team No:
Criteria Maximum Mark Achieved Mark Novelty of Idea
5
Visual reflection and influence
5
Project appearance & Style
10
Working order of
manufacturing machine
15
Feasibility on Start up
10
Evidence of strong team
works
20
Design and Planning
evidences
20
Demonstration of team
manufacturing activities
15
Total Marks 100
Appendix G2:
Australian College of Kuwait
Department of Mechanical Engineering
Oral Exam Marking Scheme
Total Weightage (30%)
STUDENTS’
NAME
ID SIGNATURE Question Mark 100
points
