















































































Study with the several resources on Docsity
Earn points by helping other students or get them with a premium plan
Prepare for your exams
Study with the several resources on Docsity
Earn points to download
Earn points by helping other students or get them with a premium plan
This document emphasizes the significance of proper subject-verb agreement and paragraph construction in creating clear and effective technical texts. It discusses the importance of these elements in engineering contexts, using examples from laboratory experimentation and ground water resource management. The document also touches upon the use of noncount words and transitional phrases.
Typology: Assignments
1 / 87
This page cannot be seen from the preview
Don't miss anything!
















































































Effective Technical Communication --Eisenberg--T 10.5.E General overall coverage of the major topics of technical writing..includes proposals, letters, and reports Writing for Science, Industry, and Technology--Hirschhorn--T 11.H Especially good Appendix where information may be gathered by writers. An approach to writing that takes the writer from the beginning of the process to the end product. English for Science and Technology--Huckin/Olsen--T 11.H Good book for the nonnative speaker in the process of report construction. Designing Technical Reports--Mathes/Stevenson--T 11 f.M A process approach to the writing of a technical presentation from the information side not from the form of the report procedure. How to Write and Publish Engineering Papers and Reports--Michaelson--T 11.M Primarily aims at the writing of papers for publication, , but does a good job of looking at quality of writing and the concern for the reader. Technical Writing--Principles and Practices--Miles--T 11.M A general text to help with basic problems and a great deal on the process of getting started. Technical Writing--Turner--T 11.T A teaching text with a good visual format--nice section on memo writing. Technical Writing--Fear--T 10.5 F For the writer who wants instruction in clear concise steps. Reporting Technical Information--Houp/Pearsall--T 11.
The best of the group for future use and present needs. Gives lots of examples and helps in the writing process.
Title: The title should be as brief as possible, consistent with clarity. Seven to eight well chosen words is a typical length. Industry readers do not need vast explanations; they need clear directions to the report within. Abstract (Summary): Although it is placed first it should not be written until all other parts of the report have been completed. It should state, in simple declarative sentences what was attempted and accomplished, how it was accomplished only if special techniques were utilized, and what was achieved. That is, it should contain the main results and the main conclusions based on the results. The abstract should be written with the expectation that it will be printed separately from the report. This is both the shortest and most difficult section to write. It is also the most important. In technical publications, the abstract, and only the abstract, is what most people will read. Therefore, it must communicate all the relevant ideas and results in 1- paragraphs. (250-350 words) Remember that in the abstract, details of the experiment, which are in the past, need a past tense verb. The use of the past tense verb will keep the reader from getting confused over when actions took place. We use this kind of an abstract to allow the reader to see what was accomplished along with what was actually desired when the experiment began. Engineers out in industry do not have time need great volumes of reports. They rely on the abstracts to give them the insight into what the experiment was about. Table of Contents: List each heading along with the page where it can be found in the report. The Table of Contents is not listed, nor is the Abstract. One is obvious (table); the other should not be listed because it cannot rely upon the report for backup, for figures, or for additional information, The Abstract must stand alone and present the required information without any need for the reader to go into the report for explanation. Nomenclature Listing: List and define all symbols used in the report. They should be listed alphabetically, Arabic then Greek. Whirlwind readers need to have a place where they can easily find an explanation of the symbols that you use in the Analysis section. Be aware that abbreviations should be left in the text and not in the Nomenclature i.e. Fast Fourier Transform (FFT). Introduction: The introduction should state the motivation for the experiment and the background information that is relevant for the present study. Note that the essential task for the introduction is to orient the engineering staff to the substance of the experiment and the context in which it was executed. Whirlwind corporation has invested a great deal of money in both the experimental and simulation equipment for you to prepare your findings. There is a need to give the Whirlwind engineers a clear picture of why you have chosen to do the experimentation that you are conducting. Make sure that you refer to the product that is being considered and the importance of the work that you are doing, especially why it will be beneficial to the
development of the product. When referring to the present report, it is acceptable to use the present tense. Future tense will explain what could be projected into future circumstances. In the introduction make use of an active voice. Use direct statements and stay away from the passive voice as much as you can in technical writing. For example, use, "We boiled the water.", not "The water was boiled by us." The introduction should briefly introduce the material contained in the report by noting what is presented in each of the sections to follow. Most Whirlwind engineers do not look at the Table of Contents. It is therefore important for them to briefly know what you have in store for them after you have motivated them to read your report. Analysis: Each experiment can, and should be analytically supported when presented in this section. The analysis should proceed from the general (and well-known) basic relationships and evolve the specific formulae to be used in the interpretation of the data. Note that the symbols must be clearly defined. It is usually appropriate to make use of a defining sketch. All of the symbols used should appear in the "Nomenclature" described above. Analytical results which have been previously derived and which are readily available, for example equations from a text, can be quoted with suitable reference. Their derivation need not be repeated, if that derivation is not important to the Whirlwind engineer's understanding of the experiment. All relevant mathematical analysis should be presented. What is crucial to a good analysis are the supporting explanations and commentary on the mathematics. Do not require the reader to consult lab handouts or textbooks to understand the specific analysis required for the experiment. If it is important enough to mention, it is important enough to include. Experimental Equipment and Procedure: A schematic representation of the experimental equipmentor simulation pogram, including detailed views of unusual or important components, is a valuable aid in informing the reader about the experiment. The sketch can be used to document pertinent dimensions of the apparatus and it can be used to specify the specific experimental equipment used for the study. If the procedure used in the experiments is not an established one, it is necessary to include details of the techniques used. The criterion here is that someone familiar with the general area of investigation should be able to exactly reproduce your experiments from the information given in this section. Be careful to describe the experimental procedure in the past tense. You may slip into the present tense when describing the procedure needed to perform the experiment by a second party. In this section, the report's flow and overall feel can be destroyed by an incomplete or incorrect discussion of the experiment procedure and equipment. Some major points to remember are: 1 - When first referencing a figure, give the figure on the same page (or next page) as the
Results: This is the section where the answers obtained from the analysis or experiments are presented. This section should contain short declarative statements of the results in reference to your presentation of specific graphic or tabular data which are also presented. The purpose of these statements is to tell the reader (without discussion) what the author's interpretation of the results are, based upon the answers or data which are also presented. Keep in mind that the same data or answer could be interpreted in more than one way, thus the importance of your stated results. When stating these results vary your sentence structure. Don't fall into colloquial, jargonish, or slang language, but aim for smooth flowing paragraphs which show more than just a mass of subject-verb-object structures. This section is a logical presentation of what was observed in the experiment. Don't forget that your readers may have picked up your report in mid- stream, meaning that they have read the Abstract then possibly gone directly to the Results. Never assume that the report will be read from page 1 to the end. It seldom happens that way. In the industrial arena only certain things are important to certain people, therefore you will need to prepare readers for the sections that you write. This is especially important in the Results section where you want your readers to see the results in the same light that you do. Five birds sitting on a fence mean a lot of different things to a lot of different people. The communicator should also distinguish between "Figures," which are schematic drawings, photographs, graphs, etc. and "Tables," which are tabular compilations of data or computational results. Each type of data presentation should be sequentially numbered with a title: e.g. "Figure 1. Schematic of the combustion chamber." Give readers a sense of what you observed without an elaboration of what it means. While you are to present your data without discussion, do not present it without explanation. A results section with only tables and graphs in it is hard to understand. Remember, you want to make it as easy as possible for the reader to understand your message. Discussion: This section may start with a very brief summary statement of the results and then proceed to a discussion of these results. The principal task is to interpret the results, to note what is "as expected", what is unexpected, and what is of technical interest. The interpretation of the results in terms of the motivation for the experiment and its correlation to the current Whirlwind Corporation project should be the focus of the discussion. The discussion could involve a comparison with other similar investigations or comparison with expected results. The strong points of the work should be brought out here along with any limitations, because if the writer does not point out the limitations of his work, someone else surely will later. It may also be legitimate to comment on possible future investigations. Discuss the experimental
specific results, using references to the accuracy of the measurements. It is useful to note the estimated uncertainties and their effect on the calculated values. For example: "The pressure was 0.0 + in H 2 O and the velocity was 30 + 10 fps. Note that the "information content" of this example is much larger than the statement: "the manometer liquid was fluctuating and the pressure could not be accurately measured." It is extremely important to provide specific discussions and avoid vague modifiers such as: greater than, about, like, and sort of. Keep in mind that good paragraph construction will present a thesis statement or idea and then give supporting details for that thesis. When new points need to be made make sure you move to new paragraphs. You should design the discussion to follow a logical progression that will support the conclusions of the next section. Judge the information that you are providing to the readers. Readers have specific expectations. They expect to be presented information in a pattern that presents what is known first and then what is new second. Sentences start with old or known information and then expand upon this information with new related information. Conclusions: A useful style is to state: "The following conclusions are supported by the results of this study": and then to list these in one or more simple (declarative) sentences using numbers to differentiate each separate conclusion. See the summary page in the Signal Processing section for an example. Remember that Whirlwind engineers are looking for concise statements that clearly tell them what your results and discussion have formulated. They are not interested at that point about further investigation or explanation. They want the masses of data synthesized into the briefest conclusions that you can make. References: The list of references used should be included, with great care taken to follow the specified format of the organization for whom the report is being written. The suggested format for this lab is shown below. References are to be grouped at the end of the manuscripts and are to be given as follows:
When proofreading your report make sure you are aware of the following:
COMPOUND WORDS