Class 21 Technical Report Sections and Content EPD 397 Technical Communication Fall 2014 Section 10

Typical scientific report structure (“IMRAD”) starts general, then becomes specific about the work, and then generalizes 2 Source: Glasman-Deal, Hilary, 2010 Science Research Writing for Non-Native Speakers of English. Imperial College Press. Why did I do the work? Summarizes relevant prior work (literature review) Starts general, then focus Describes why this work is needed Why did I do the work? Summarizes relevant prior work (literature review) Starts general, then focus Describes why this work is needed What is most important about my work? How may I improve on my work? Build on discussion. Generalize and relate to Introduction What is most important about my work? How may I improve on my work? Build on discussion. Generalize and relate to Introduction How did I do the work? a.k.a. Materials and Methods, Experimental Procedures How did I do the work? a.k.a. Materials and Methods, Experimental Procedures What did I observe or find out? Overview (avoid discussing results in detail if report has Analysis section) What did I observe or find out? Overview (avoid discussing results in detail if report has Analysis section) Why are my findings significant and useful? What are the limitations of my work? Explain and interpret results Start focused, then generalize Why are my findings significant and useful? What are the limitations of my work? Explain and interpret results Start focused, then generalize Results Methodology Abstract Summary and Conclusions Introduction Analysis and Discussion

What do we already know? What don’t we know? Synthesize relevant prior work from credible sources, with citations to Reference list Describe gap in understanding or capabilities in detail, and effects on stakeholders Define terminology and acronyms What do we already know? What don’t we know? Synthesize relevant prior work from credible sources, with citations to Reference list Describe gap in understanding or capabilities in detail, and effects on stakeholders Define terminology and acronyms EPD-397 report content follows logical progression; descriptive section titles depend on audience and purpose 3 Source: Glasman-Deal, Hilary, 2010 Science Research Writing for Non-Native Speakers of English. Imperial College Press. Why is this project important? Why did I do this work? Summarize problem or opportunity; current state, ideal state, gap Identify stakeholders; summarize effect on stakeholders; introduce ethical considerations Summarize objectives and scope of your work Why is this project important? Why did I do this work? Summarize problem or opportunity; current state, ideal state, gap Identify stakeholders; summarize effect on stakeholders; introduce ethical considerations Summarize objectives and scope of your work What is most important about my work? How may I improve on my work? Build on Analysis and Discussion. Generalize and relate back to Introduction: problem, gap, ethical improvements, objectives and scope Conclusions must be supported by content in other sections Recommendations may explain how work is applicable to other situations What is most important about my work? How may I improve on my work? Build on Analysis and Discussion. Generalize and relate back to Introduction: problem, gap, ethical improvements, objectives and scope Conclusions must be supported by content in other sections Recommendations may explain how work is applicable to other situations How did I do this work? Describe how you gathered your data, information Describe how you analyzed data, information: assumptions, equations, calculations, criteria, weighting factors The Analytical Methodology may be in Background or at beginning of Results How did I do this work? Describe how you gathered your data, information Describe how you analyzed data, information: assumptions, equations, calculations, criteria, weighting factors The Analytical Methodology may be in Background or at beginning of Results What did I observe or find out in my research? Describe what you observe in the results of your research and analysis Include tables and graphics to summarize results, show trends, depict results Results may be included in Analysis and Discussion of Results What did I observe or find out in my research? Describe what you observe in the results of your research and analysis Include tables and graphics to summarize results, show trends, depict results Results may be included in Analysis and Discussion of Results Why are my findings significant and useful? What are the limitations of my work? (not the same as limitations in Project Significance) Explain and interpret your results; relate back to objectives of work Explain the ethical implications of your findings: effects on stake holders, Code of Ethics, relevant ethical tests Why are my findings significant and useful? What are the limitations of my work? (not the same as limitations in Project Significance) Explain and interpret your results; relate back to objectives of work Explain the ethical implications of your findings: effects on stake holders, Code of Ethics, relevant ethical tests EPD 397 report section titles are more descriptive than generic content titles Results Analytical Methodology Executive Summary Conclusions and Recommendations Analysis and Discussion of Results Background(s) Introduction Analytical and evaluative sections Analytical and evaluative sections

EPD 397 reports can be “mapped” into report structure: Example: Comparative Analysis of New Technologies to Solve Problem 4 Sources: Glasman-Deal, Hilary, 2010 Science Research Writing for Non-Native Speakers of English. Imperial College Press. Grossenbacher, L. and McGlamery, T., Organizing and Outlining your Formal Report, EPD 397 Technical Communications, Section 10 Course Page, Why is this project important? Why did I do this work? Summarize problem or opportunity; current state, ideal state, gap Identify stakeholders; summarize effect on stakeholders; introduce ethical considerations Summarize objectives and scope of your work Why is this project important? Why did I do this work? Summarize problem or opportunity; current state, ideal state, gap Identify stakeholders; summarize effect on stakeholders; introduce ethical considerations Summarize objectives and scope of your work What is most important about my work? How may I improve on my work? Build on Analysis and Discussion. Generalize and relate back to Introduction: problem, gap, objectives and scope, ethical improvements, Conclusions must be supported by content in other sections Recommendations may explain how work is applicable to other situations What is most important about my work? How may I improve on my work? Build on Analysis and Discussion. Generalize and relate back to Introduction: problem, gap, objectives and scope, ethical improvements, Conclusions must be supported by content in other sections Recommendations may explain how work is applicable to other situations Why are my findings significant and useful? Explain and interpret your findings; relate back to main objective of your work Explain the ethical implications of your findings: effects on stake holders; refer to Code of Ethics, relevant ethical tests Why are my findings significant and useful? Explain and interpret your findings; relate back to main objective of your work Explain the ethical implications of your findings: effects on stake holders; refer to Code of Ethics, relevant ethical tests What do we already know? What don’t we know? How did we evaluate? Describe current technology or solution(s) and why flawed or lacking in capabilities Explain criteria used to evaluate the current solution(s) and new technologies (e.g., efficiency, ease of manufacturing, cost, environmental effects, time to implement) Describe how you analyzed data, information: assumptions, equations, calculations, criteria, weighting factors Define terminology and acronyms Synthesize relevant prior work from credible sources, with citations to Reference list What do we already know? What don’t we know? How did we evaluate? Describe current technology or solution(s) and why flawed or lacking in capabilities Explain criteria used to evaluate the current solution(s) and new technologies (e.g., efficiency, ease of manufacturing, cost, environmental effects, time to implement) Describe how you analyzed data, information: assumptions, equations, calculations, criteria, weighting factors Define terminology and acronyms Synthesize relevant prior work from credible sources, with citations to Reference list What did I learn? For each technology: Provide technical description, necessary definitions, useful analogies, figures Assess strengths and weaknesses relative to evaluation criteria Clarify where this technology is an improvement over current solutions. Include tables and graphics to summarize results, show trends, depict results What did I learn? For each technology: Provide technical description, necessary definitions, useful analogies, figures Assess strengths and weaknesses relative to evaluation criteria Clarify where this technology is an improvement over current solutions. Include tables and graphics to summarize results, show trends, depict results Description of New Technologies Executive Summary Conclusions and Recommendations Analysis and Discussion of … Technical and/or Historical Background of … Introduction Analytical and evaluative sections Analytical and evaluative sections

Write conclusions to reflect technical insight and relate to problem or need: 5 Scenario: In urban areas with hard surfaces, storm water run-off can flood and damage streets and undermine landscaping, sidewalks and building foundations. WUWF, accessed 19-Nov-2014http://wuwf.org/post/manna-food-pantry-hopes-come-back-after-storm City of Excelsior Springs, Mo, accessed 19-Nov-2014http:// These effects can be costly; therefore, many municipalities require new construction to employ technologies to reduce erosion and damage. Examples of these technologies are permeable paving, and bio-retention areas.

Write conclusions to reflect technical insight and relate to problem or need: 6 Storm water mitigation systems incorporating permeable paving and bio- retention, such vegetated basins and swales, have the potential to reduce storm water runoff by up to 90% in most urban installations. This reduction is often sufficient to eliminate erosion and flood damage in urban landscapes, streets and building foundations caused by storm water runoff. Permeable paving, bio-retention basins, and bio-swales may reduce storm water runoff. Statement is true, but is so obvious to be superficial Conclusion summarizes the types of systems considered in the report Potential reduction in run-off is quantified: up to 90% Solution is tied back to problem of damage caused by runoff – “solves the problem” Conclusion summarizes the types of systems considered in the report Potential reduction in run-off is quantified: up to 90% Solution is tied back to problem of damage caused by runoff – “solves the problem”