Report writing guide Oregon Institute of Technology Mechanical and Manufacturing Engineering and Technology Department WRITING GUIDE FOR FORMAL TECHNICAL REPORTS Robert K Wattson Jr In Collaboration With Wayne E Phillips Charles A Hermach th Revision June
Oregon Institute of Technology Mechanical and Manufacturing Engineering and Technology Department WRITING GUIDE FOR FORMAL TECHNICAL REPORTS Robert K Wattson Jr In Collaboration With Wayne E Phillips Charles A Hermach th Revision June CFOREWORD This is not a technical report It is not intended to read or to look like one It is a very small book about technical report writing Read it carefully Use it when you are writing reports of laboratory projects It is the Department's style manual in the same sense that commercial companies have style manuals You will be required to comply most rigidly with its instructions CONTENTS I INTRODUCTION II ELEMENTS OF THE ENGINEERING WRITING STYLE III ORGANIZATION OF A TECHNICAL REPORT IV MAJOR SECTIONS OF THE TECHNICAL REPORT Title Page Table of Contents First Page of Text Summary Introduction Notation Analytical Development Experimental Apparatus and Method Results Discussion Conclusions and Recommendations References Tables Illustrations Graphs Appendix Binding and Labeling V EFFORT REQUIRED by Wayne E Phillips VI GRADING by Wayne E Phillips VII ERRORS FREQUENTLY FOUND IN STUDENT REPORTS I INTRODUCTION Engineering writing style is quite structured has been for many years and will undoubtedly continue to be so The reasons are Care must always be taken to use words the exact meanings of which are known to the engineering community Words phrases and sentences must say exactly what is intended Unusual terms when ?rst introduced must be de ?ned C Technical writing is highdensity stu ? the information is packed in indeed it must be for there is mo much of it Every sentence in an engineering report must convey additional information and to the extent possible must relate that information to what went before Because of that high information density technical reading is a slow process in the toughest cases sometimes a single sentence can take minutes to assimilate For this reason the reader should be confronted with familiar terms uncomplicated sentences short paragraphs these help him go faster The readership is already familiar with the style is reasonably comfortable with it and expects more of the same II ELEMENTS OF THE ENGINEERING WRITING STYLE A de ?nite detailed organization scheme is followed The general style is terse the sentences short to only moderately long Word usage grammar and sentence structure must be impeccable Third person is used in descriptive material An exception is the use of ?rstperson plural in mathematical developments Thus we see that Occasionallyonce every few yearsyou will simply have to mention yourself speci ?cally Do not be stilted about it Good my experience is that or I have found that Bad It is the experience of the author that Second person is never used Use of the third person almost compels the use of passive voice Passive voice directs attention to the project not to the persons who performed it Thermometers were located at This is not a fast rule many sentences though not referring to what someone did work out better in active voice this one did
Documents similaires
-
70
-
0
-
0
Licence et utilisation
Gratuit pour un usage personnel Attribution requise- Détails
- Publié le Apv 18, 2022
- Catégorie Creative Arts / Ar...
- Langue French
- Taille du fichier 75.5kB