Technical Writing Notes #2

Writing in Engineering and Mathematics: IEEE-Institute of Electrical and electronic engineers The profession in which knowledge of mathematics and natural sciences is applied with judgment to develop ways to benefit mankind: • • • • •

Civil Mechanical Computer Electrical Environmental

Types of Writing: • • • • •

Abstracts Executive Summaries Lab Reports Design Reports Proposals

Abstracts: • • • •

Purpose Key Findings Significance Major conclusions

Executive Summary: • • • • •

1-page long summary of proposal Purpose: problem or goal Essentials of program Total expense of project Qualifications (name, history, activities)

Lab Report: • •

• • •

Title Page < 10 words Abstract ○ Note: Verb Tenses ○ Experiment in past tense ○ Theory, reporting of equipment in present Introduction Methods and Materials (or equipment) Experimental Procedure

• • • • •

Results ○ Calculations, tables, and figures ○ Interpret Conclusion References Appendices Further Reading (optional)

Design Report: •

•

•

•

•

Summary—call it a… ○ Abstract iff technical audience ○ Executive Summary iff management audience ○ Concise synopsis of the design itself, the motivation for having the design, and the design’s effectiveness Introduction ○ Design problem, the objectives of the design, the assumptions for the design, the design alternatives, and the selection of the design being reported ○ Also included of the transition is mapping of the entire report. Discussion ○ Presents the design itself, the theory behind the design, the problems encountered (or anticipated) in producing the design, how those problems were (or could be) overcome, and the results of any tests of the design ○ This part usual consists of two, three, or four main headings. Conclusion ○ Summarize design and testing work ○ If fails, note why ○ Gives perspectives for how design will be used in the future. Appendices ○ Calculations and supplemental information ○ You should title appendix, place a heading on each table, and place a caption beneath each figure

Proposal: • • • •

Executive Summary Introduction Project description or program Timeline and milestones

• •

Budget qualifications