Improving Technical Writing Skills R E AbdelAal COE

Improving Technical Writing Skills R. E. Abdel-Aal COE Department

Some Facts, Quotations n Clear writing is an indication of clear thinking! “In today’s workplace, writing is a ‘threshold skill’ for hiring and promotion among professional employees” n Report, US National Commission on Writing, Sept 2004 n How do fresh US engineers spend their time at work 1? Writing Other Work 36% 1 Pneena Sageev and Carol J. Romanowski A Message from Recent Engineering Graduates in the Workplace: Results of a Survey on Technical Communication Skills, Journal of Engineering Education, 1 October 2001, pp 685 -693 22% Other Oral Discussions 32% 10% Oral Presentations

Contents • • • Motivation (Why? ) What makes good technical writing? What are the main writing skills required? The writing task and process Typical Structure for Paper/Report Tips for good writing style How to improve your writing? Conclusions References

Motivation Writing clearly and effectively is essential to an engineer: • n n Engineers need to communicate results of their work in writing to peers, bosses, and decision makers: Reports, Proposals, Quotations, Request for Quotations, Research Papers, etc. Lives are often affected not only by the accuracy of an engineer’s work, but also by clear and convincing presentation of his motivation, conclusions and recommendations If you are a decision maker, how would you take spelling/grammar errors in an important engineering report?

What makes good technical writing? • • Formal, Direct • Relevant to defending Modular, Structured of a viewpoint Focused, Objective • Shows insight & critical Simple, Coherent thinking Uses established theories • Aware of audience & terminology Concise: No padding or Original redundancy • Contributes to the body Consistent of knowledge Clarity and Flow

What are the main writing skills? Synthesize Findings Style Develop Convincing, High-Level Persuasive Arguments Effective Data Presentation Organization Referencing Punctuation Grammar Spelling Low-Level

The writing task n Wish list: Productive- Minimum frustration! Timely Leads to a final product to be proud of n To achieve this, the task must be: Focused and Organized Started early, as many revisions are needed Adopt a ‘Writing Process’

The Writing Process n Define the topic - clear focus n Collect the data, perform the experiments, etc. n Organize the document: The outline Write first Draft - writing, writing and writing again. . . n n Revise: Focusing on higher-order concerns n Proofread: Focusing on lower-order concerns

Typical Structure for Report/Paper n Title: Not too short, Not too long n Abstract: 300 words n n n Write this at the end Scope, Motivation, Achievements, Key results, Conclusions Introduction One paragraph for each of the following: n Background / history n Motivation n Your contributions n Organization of the document

Typical Structure for Report/Paper, Contd. n Background, Theory, Literature Review n n Describe background necessary to understand the rest of the document Previous Related Work n n Cite and briefly discuss other related work Mention how it differs from your work Mention their limitations, but be polite Your Approach, Experimental Procedures n n Describe your approach Describe any experimental setup and metrics used to evaluate your solution against previous work

Typical Structure for Report/Paper, Contd. n Results and Discussion n n Use graphs and tables to present your results Refer the graphs / tables in the text… Describe and discuss your work and ideas, do not just state them Conclusions/Recommendations n n Main conclusions and recommendations derived Suggestions for possible future work n Acknowledgements n References

Some tips for good writing style - Going beyond spelling and grammar n Write clearly, explicitly, and concisely. Long sentences, ‘delayers’ and ‘distracters’ frustrate readers n Use formal language: e. g. no contractions (couldn't, hasn’t etc. ) n Write such that you get yourself understood: written words need to be chosen more carefully than spoken words n Cut the fat, even one word “counts”! n Avoid exaggerations and unnecessary qualifiers: (very, basically, actually. . ) n Avoid clichés: “last but not least? ” n Avoid overusing prepositional phrases: the, in, over, of, for, at. . n Ensure clarity: “who did what to whom? ” Use active voice

How to improve your writing? n Realize the importance of good writing n Read a lot! and pay attention to others’ writing style n Read critically what you have written before submission n Get others to read what you have written: Feedback, Quality Assurance n Practice good writing in all that you write: emails, letters, etc. n Know your target audience: What they know already, what they expect to know from your document n Know your objective: to document? , inform? , persuade? . . n Utilize the plenty of information and help available on the Web (Check the ABET page on the COE Website)

Conclusions n n n n n Writing skills are important for a successful career in engineering Several criterion for good technical writing: Simplicity and clarity Writing skills span several levels: from spelling to argumentation Need to adopt a writing process and allow adequate time Typical structures for papers and reports Guidelines for writing in style Strategy for improvement Get convinced and committed and start practicing There is plenty of helpful resources around

References n The ABET Accreditation page on the COE Website: http: //www. ccse. kfupm. edu. sa/coe/abet_accreditation. html n http: //dsl. serc. iisc. ernet. in/~haritsa/techwrite. ppt n http: //academic. sun. ac. za/taalsentrum/Power. Point/Writing. Skills. MPA. ppt n http: //www. depts. ttu. edu/che/classes/che 2306/Documents/sageev. pdf n http: //www. northwestern. edu/searle/programs_and_research/researchande valuation/PDFs/28 Yalvac. Smith. Troy. Hir. pdf n http: //ecow. engr. wisc. edu/cgibin/getbig/cee/949/bank/journalclu/howtowriteagoodtechnicalpaper. pdf n http: //www. sussex. ac. uk/engineering/documents/guide_to_technical_report. pdf n http: //www. ocf. berkeley. edu/~anandk/math 191/Technical%20 Writing. pdf n http: //www. soton. ac. uk/~sesg 1009/lectures/reportwritingchecklist. pdf n http: //www. ivt. ntnu. no/imt/courses/tmr 4240/assignments/2008/Assignment _3/technical%20 writing. pdf