GOOD REPORT WRITING

By
Sandeep M Joshi

Department of Mechanical Engineering

Pillais Institute of Information Technology, Engineering,
Media Studies and Research
New Panvel

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

OUTLINE OF PRESENTATION
Good Report Writing

General Guidelines to Writing a Report

Abstract
Introduction
Literature Review
Design Parameters and Simulation
Fabrication
Experimentation
Results & Discussion
Conclusions and Recommendation for Future Work/Modifications
Report Format

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

GENERAL GUIDELINES
Good Report Writing

Report be Written in Third Person

9 I, We, Them, etc. should not appear anywhere in the report

Contents of the Report Should Flow Naturally

9 Each chapter should be independent and self explanatory
9 Each chapter or section should have an introduction, linking it to the earlier sections
9 Each section, sub section, etc. should have a conclusion

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

ABSTRACT
General Guidelines for Good Report Writing

Purpose
9 General idea about the report
9 Attract

Contents
9 Background and need for the topic (relevance)

50%

Include prior work done

May state the scope of the current work

9 Aim, objectives, deliverables

9 Methodology
9 Expected results

Length
9 Post graduate
9 Under graduate

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

25%
15%
10%

2 to 3 pages
1 page

CHAPTER 1: INTRODUCTION
General Guidelines for Good Report Writing

Contents and Length

Contents
9 Background

40%

Major Portion

9 Aim, objectives
9 Methodology
9 Layout of report

35%
15%
10%

Brief introduction to later chapters; 2nd chapter onwards

1st chapter should not be mentioned again in the Layout

Length
9 Post graduates
9 Under graduate

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

3 to 5 pages
3 pages max

CHAPTER 2: LITERATURE REVIEW

General Guidelines for Good Report Writing

Purpose of Literature Survey

Lay the Foundation of the Work

9 Study what has been done so far

Find Gaps between Knowledge/Technologies Available, which if Filled will be

Advantageous
9 Advantages, disadvantages, scope for further improvement
9 Should have comparative tables

Conclude with Best Possible Option

9 Include references which are useful, best results and best technology
9 Table for each subgroup comparison
9 Should naturally lead to the work to be done

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

CHAPTER 2: LITERATURE REVIEW

General Guidelines for Good Report Writing

Contents
9 Introduction
In very brief to maintain connectivity
Introduction about what to expect in this chapter
E.g. Start with various options, then look at the one which will be used in more detail..etc

9 Last paragraph should be conclusion (this holds for each Section)

Conclusion for each section, sub-section, each thing surveyed (e.g. Each option studied)
Compare and conclude overall Review

Reader Should Follow Your Thought and Judgment

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

CHAPTER 3: DESIGN PARAMETERS

AND

SIMULATION

General Guidelines for Good Report Writing

Purpose
9 To convey the design considerations and calculations

Content
9 Briefly connect with literature review
9 Connect with last set of conclusions
9 Discuss parameters involved
E.g. weather data for Mumbai, performance parameters for I C Engine or Compressor etc.
All these parameters should have been mentioned in previous chapter

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

CHAPTER 3: DESIGN PARAMETERS

AND

SIMULATION

General Guidelines for Good Report Writing

Overall System Layout

Design Parameters along with Design Consideration (Assumption)

9 Inputs
9 Outputs

Schematic Diagram
9 Component layout, state points, nomenclature

Relevant Process Charts

9 p-h, T-s, psychometric charts etc
9 Flowcharts for the simulation

Design
9 Equations with references and justification for the specific case

Iterations
9 Clearly state why and to what extent the parameters are being changed

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

CHAPTER 3: DESIGN PARAMETERS

AND

SIMULATION

General Guidelines for Good Report Writing

Final Design

Justification of Assumption
9 MOC - Material of construction
9 Heat transfer
9 Mass transfer
9 Auxiliary power
Blower/ Pump Power

9
9
9
9
9
9
9
9

Size
Weight
Operability
Reliability
Simplicity
Initial cost
Operative cost
Lifecycle cost

Compare with Available Systems

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

10

CHAPTER 4: PROTOTYPE FABRICATION

General Guidelines for Good Report Writing

Content

Brief Link with Parameters and Design

Manufacturing Drawing
9 Overall system
9 Individual system components

Bought out Items

9 Controller specifications, sources

Summery Table
9 Components
9 Size
9 Weights
9 Cost
9 Material of construction (MOC)

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

11

CHAPTER 5: EXPERIMENTATION
General Guidelines for Good Report Writing

Contents

Introduction
9 Entire background in brief
9 Purpose of testing
9 Test procedure

Test Setup
9 System design
9 Schematic of experimental setup
With all details, pumps etc.

9 Instrumentation
Range, accuracy, readability, precautions
Cost, source of procurement

9
9
9
9

Testing procedure
Check off lists including precautions
Data sheets
Relevant property charts, tables

Experimental Data

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

12

CHAPTER 5: EXPERIMENTATION
General Guidelines for Good Report Writing

Results and Discussion

Data Reduction

Conclusions and Recommendations for Modifications

Guidelines for Fabrication Modifications

Series of Experiments
Discuss the Trends
9 Explain why

Perform Error Analysis

Conclude

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

13

CHAPTER 6: CONCLUSIONS AND FUTURE WORK

General Guidelines for Good Report Writing

Content

Reintroduce Topic
Aim, Objective
Methodology
Relevant Literature Review
9 Take best available to compare
9 Best current performance should be listed

10%
10%
10%
10%

On the basis of mass/heat transfer coefficient, COP, efficiency, etc.

Size, weight etc to be specified

9 System developed details to be listed

Size weight etc
Output details

Hence this System is Better

How to Further Improve,
what else can be done

Recommend

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

14

REFERENCES AND APPENDIX

References Arranged Alphabetically and Numbered

Example
9 Journal
Single Author: Serial no., author (year), topic, publication, volume, page nos.
Elsarrag E (2006), Performance study on a structured packed liquid desiccant regenerator, Solar Energy,
80, pp 16241631
Two Authors: Serial no., Author1 and Author2 (year), topic, publication, volume, page nos, year
Gommed K and Grossman G (2007), Experimental Investigation of a Liquid Desiccant System for Solar
Cooling and Dehumidification, Solar Energy, volume 81, pp 131-138
Three or more Authors: Author1, author2, author3 (year)
Haim I, Grossman G, Shavit A (1992), Simulation and Analysis of Open Cycle Absorption systems for solar
cooling, Solar Energy, volume 49, No. 6, pp 515-534

9 Book
ASHRAE Handbook of Fundamentals 2001, Sorbents and Desiccants, ASHRAE Hand Book-Fundamentals,
Chapter 22, American Society of Heating, Refrigerating and Air-Conditioning Engineers, Inc., Atlanta G A,
USA 2001

9 Web
http://www.eere.energy.gov/de/pdfs/conf-03_der_pr/lowenstein.pdf last visited on 20/06/2009

9 Patent
Maisotsenko V, Gillan L E, Heaton T L and Gillan A D, Indirected Evaporative Cooling Mechanism,
United States Patent Application Publication, Pub. No. US 2004/0061245 A1, 2004

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

15

REPORT FORMAT

Paper
9 Quality
Whiteness
Weight

white bond paper

95% or above
70 gsm

9 Size

Standard A 4

Height
Width

297 mm
210 mm

9 Type-setting, text processing and printing

The text shall be printed employing laserjet or inkjet printer
The text having been processed using a standard text processor
The standard font shall be Times New Roman of 12 pts with 1.5 line spacing

9 Page format

Top margin
Bottom margin
Left margin
Right margin

the printed sheet shall have the following

writing area and margins
15 mm
22 mm
30 mm
20 mm

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

16

REPORT FORMAT

Pagination
9 Page numbering in the text of the report shall be Hindu-Arabic numerals at the center of
the footer
9 Page number 1 for the first page of the Introduction chapter shall not appear in print
Only the second page will bear number 2

9 Subsequent chapters shall begin on a fresh page

9 Pagination for pages before the Introduction chapter shall be in lower case Roman
numerals
e. g. i, ii, iv, ix etc

Paragraph Format
9 Vertical space between paragraphs shall be about 2.5 line spacing
9 A paragraph should normally comprise more than one line
9 The first line of each paragraph should normally be indented by five characters or 12 mm
You can choose not to indent if you have provided sufficient paragraph separation

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

17

REPORT FORMAT
Chapter and Section Format
9 Each chapter shall begin on a fresh page with an additional margin of about 75 mm
9 Chapter number and title shall be printed at the center of the line in 18 pt (6 mm) font size
in bold face using upper case
9 A vertical gap of about 25 mm shall be left between the chapter number and chapter title
lines and between chapter title line and first paragraph

Sections and sub sections

9 Chapter can be divided into sections, subsections and sub-subsection
To present different concepts seperately

9 Sections and subsections can be numbered using decimal points

e. g. 2.2, 2.3.6 etc

9 Section and subsection titles along with their numbers in 16 and 14 pt (5 and 4 mm) fonts
respectively, in bold face with 15 mm space above and below these lines

Chapters, sections and subsections shall be included in the contents with page
numbers flushed to the right
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

18

REPORT FORMAT

Table and Figure Format

9 As far as possible tables and figures should be presented in portrait style
Small size tables and figures (less than half of the writing area) should be incorporated within the text
while the larger ones may be presented in separate pages

9 Tables and figures shall be numbered chapter wise

e. g. Figure 5.4 or Fig. 5.4

9 Table number and title will be placed above the table

9 Figure number and caption will be located below the figure

Binding
9 The report shall be hard cover bound in leather or rexin with BLACK colour
9 The front cover shall contain the following details
Full title of report in 22 pt font size properly centered and positioned at the top
Your full name in 15 pt font size properly centered and positioned at the middle of the page
40 mm dia replica of institute emblem followed by the name of the department, name of the institute and
the year of submission, each in separate line, properly centered and located at the bottom of the page

9 All lettering shall be embossed in golden colour

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

19

REPORT FORMAT
Title Sheet
9 This shall be the first printed page of the report and shall contain the submission
statement, your name and roll number (examination seat number), name of the guide,
department, institute and year of submission
Sample copy of the title sheet

Approval Sheet
9 This will form the first page and shall not have a page number
The top line should be Report Approval for B. E. project
Sample copy of approval sheet

Contents

9 The content shall follow the abstract and shall enlist the titles of the chapters, sections
and subsection using decimal notation, as in the text, with corresponding page number
against them, flushed to the right
List of Figures and Tables
9 Two separate lists of figure caption and table titles along with their numbers and
corresponding page numbers against them shall follow the contents
Abbreviation Notation and Nomenclature

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

20

THANK YOU

Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel

21