Upload
shashanka-kshetrapalasharma
View
226
Download
1
Embed Size (px)
Citation preview
8/18/2019 Good Report Writing
1/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel1
GOOD REPORT WRITING
By
Sandeep M Joshi
Department of Mechanical Engineering Pillai’s Institute of Information Technology, Engineering,
Media Studies and Research
New Panvel
8/18/2019 Good Report Writing
2/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel2
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
8/18/2019 Good Report Writing
3/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel3
GENERAL GUIDELINES
Good Report Writing
• Report be Written in Third Person
“I”, “We”, “Them”, etc. should not appear anywhere in the report
• Contents of the Report Should Flow Naturally
Each chapter should be independent and self explanatory
Each chapter or section should have an introduction, linking it to the earlier sections
Each section, sub section, etc. should have a conclusion
8/18/2019 Good Report Writing
4/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel4
ABSTRACT
General Guidelines for Good Report Writing
• Purpose General idea about the report
Attract
• Contents Background and need for the topic (relevance) 50%
Include prior work done
May state the scope of the current work
Aim, objectives, deliverables 25%
Methodology 15%
Expected results 10%
• Length Post graduate 2 to 3 pages
Under graduate 1 page
8/18/2019 Good Report Writing
5/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel5
CHAPTER 1: INTRODUCTIONGeneral Guidelines for Good Report Writing
Contents and Length
• Contents
Background 40%
Major Portion
Aim, objectives 35%
Methodology 15%
Layout of report 10%
Brief introduction to later chapters; 2nd chapter onwards 1st chapter should not be mentioned again in the Layout
• Length
Post graduates 3 to 5 pages
Under graduate 3 pages max
8/18/2019 Good Report Writing
6/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel6
CHAPTER 2: LITERATURE REVIEWGeneral Guidelines for Good Report Writing
Purpose of Literature Survey
• Lay the Foundation of the Work
Study what has been done so far
• Find Gaps between Knowledge/Technologies Available, which if Filled will be Advantageous
Advantages, disadvantages, scope for further improvement
Should have comparative tables
• Conclude with Best Possible Option
Include references which are useful, best results and best technology
Table for each subgroup comparison
Should naturally lead to the work to be done
8/18/2019 Good Report Writing
7/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel7
CHAPTER 2: LITERATURE REVIEWGeneral Guidelines for Good Report Writing
• Contents
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
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
8/18/2019 Good Report Writing
8/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel8
CHAPTER 3: DESIGN PARAMETERS AND SIMULATIONGeneral Guidelines for Good Report Writing
• Purpose
To convey the design considerations and calculations
• Content
Briefly connect with literature review
Connect with last set of conclusions
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
8/18/2019 Good Report Writing
9/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel9
CHAPTER 3: DESIGN PARAMETERS AND SIMULATIONGeneral Guidelines for Good Report Writing
Overall System Layout• Design Parameters along with Design Consideration (Assumption)
Inputs
Outputs
• Schematic Diagram
Component layout, state points, nomenclature
• Relevant Process Charts p-h, T-s, psychometric charts etc
Flowcharts for the simulation
• Design
Equations with references and justification for the specific case
• Iterations
Clearly state why and to what extent the parameters are being changed
8/18/2019 Good Report Writing
10/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel10
CHAPTER 3: DESIGN PARAMETERS AND SIMULATIONGeneral Guidelines for Good Report Writing
Final Design
• Justification of Assumption
MOC - Material of construction
Heat transfer
Mass transfer
Auxiliary power
Blower/ Pump Power
Size
Weight
Operability
Reliability
Simplicity
Initial cost
Operative cost
Lifecycle cost
• Compare with Available Systems
8/18/2019 Good Report Writing
11/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel11
CHAPTER 4: PROTOTYPE FABRICATIONGeneral Guidelines for Good Report Writing
Content
• Brief Link with Parameters and Design
• Manufacturing Drawing Overall system
Individual system components
• Bought out Items
Controller specifications, sources
• Summery Table Components
Size
Weights
Cost
Material of construction (MOC)
8/18/2019 Good Report Writing
12/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel12
CHAPTER 5: EXPERIMENTATIONGeneral Guidelines for Good Report Writing
Contents
• Introduction Entire background in brief
Purpose of testing
Test procedure
• Test Setup System design
Schematic of experimental setup
With all details, pumps etc. Instrumentation
Range, accuracy, readability, precautions
Cost, source of procurement
Testing procedure
Check off lists including precautions
Data sheets
Relevant property charts, tables
• Experimental Data
8/18/2019 Good Report Writing
13/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel13
CHAPTER 5: EXPERIMENTATIONGeneral 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
Explain why
• Perform Error Analysis
• Conclude
8/18/2019 Good Report Writing
14/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel14
CHAPTER 6: CONCLUSIONS AND FUTURE WORKGeneral Guidelines for Good Report Writing
Content
• Reintroduce Topic 10%
• Aim, Objective 10%
• Methodology 10%• Relevant Literature Review 10%
Take best available to compare
Best current performance should be listed
On the basis of mass/heat transfer coefficient, COP, efficiency, etc.
Size, weight etc to be specified
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
8/18/2019 Good Report Writing
15/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel15
REFERENCES AND APPENDIX
• References Arranged Alphabetically and Numbered • Example
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 1624–1631
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 SolarCooling 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 solarcooling, Solar Energy, volume 49, No. 6, pp 515-534
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
Web http://www.eere.energy.gov/de/pdfs/conf-03_der_pr/lowenstein.pdf last visited on 20/06/2009
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
8/18/2019 Good Report Writing
16/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel16
REPORT FORMAT
• Paper
Quality white bond paper
Whiteness 95% or above
Weight 70 gsm
Size Standard A 4
Height 297 mm
Width 210 mm
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
Page format the printed sheet shall have the following
writing area and margins Top margin 15 mm
Bottom margin 22 mm
Left margin 30 mm
Right margin 20 mm
8/18/2019 Good Report Writing
17/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel17
REPORT FORMAT
• Pagination
Page numbering in the text of the report shall be Hindu-Arabic numerals at the center of
the footer
Page number “1” for the first page of the Introduction chapter shall not appear in print
Only the second page will bear number “2”
Subsequent chapters shall begin on a fresh page
Pagination for pages before the Introduction chapter shall be in lower case Roman
numerals e. g. i, ii, iv, ix etc
• Paragraph Format
Vertical space between paragraphs shall be about 2.5 line spacing
A paragraph should normally comprise more than one line
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
8/18/2019 Good Report Writing
18/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel18
REPORT FORMAT
• Chapter and Section Format
Each chapter shall begin on a fresh page with an additional margin of about 75 mm
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 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
Chapter can be divided into sections, subsections and sub-subsection
To present different concepts seperately
Sections and subsections can be numbered using decimal points
e. g. 2.2, 2.3.6 etc
Section and subsection titles along with their numbers in 16 and 14 pt (5 and 4 mm) fontsrespectively, 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
8/18/2019 Good Report Writing
19/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel19
REPORT FORMAT
• Table and Figure Format 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 Tables and figures shall be numbered chapter wise
e. g. Figure 5.4 or Fig. 5.4
Table number and title will be placed above the table
Figure number and caption will be located below the figure
• Binding The report shall be hard cover bound in leather or rexin with BLACK colour
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 andthe year of submission, each in separate line, properly centered and located at the bottom of the page
All lettering shall be embossed in golden colour
8/18/2019 Good Report Writing
20/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel20
REPORT FORMAT
• Title Sheet
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
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
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 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
8/18/2019 Good Report Writing
21/21
Presented by S M Joshi on 01/04/2010 at Conclave PIIT, New Panvel21
THANK YOU