TECHNICAL WRITING PRESENTATION CRITERIA FOR GOOD TECHNICAL WRITING

TECHNICAL WRITING PRESENTATION CRITERIA FOR GOOD TECHNICAL WRITING

CHAPTER GOALS 1. FACTORS THAT ARE IMPORTANT IN WRITING A GOOD REPORT 2. HOW YOUR TECHNICAL DOCUMENT WILL BE REVIEWED AND READ BY OTHERS

Part 1 content Part 2 presentation Part 3 language skills

PART 1 CONTENT 1 - timing documents - in experiments - in surveys - in projects 2 - factual information - information must be realistic

3 - § clear purpose a statement of why the work is being done § logical purpose o § § 4 - source credit mentioning the source for the information mention where to find information and done by whom

5§ understandable statistics showing information that are understandable to everyone § explaining statistics if it is not clear or canot be clearer 6 - acronyms § § don’t create or use your own acronyms don’t use acronym unless necessary and explain them

PART 2 THE PRESENTATION Title The beginning Abstract Introduction

Procedure The body Results Discussion of results

Conclusions Closure Recommendation References

Also keep in mind 1 - no bias which means no personal opinons 2 - keep it interesting explaining the importance of the work 3 - specific don’t let the reader get lost in all the information and don’t move around from a topic to anther

PART 3 LANGUAGE SKILLS 1 - no acronym 2 - new word 3 - don’t repeat words too much 4 - no miss spelling

5 - mixed long sentences going from long complicated sentences to short informative ones keeps the reader involved 6 - reasonable grammar the actions must be the right tense for example an experiment was done un the past the sentence must be in the past tense

SUMMARY 1 - acceptable technical writing 2 - good presentation of information 3 - proper language usage