SMILE
mainImage

Unit 11: Technical writing image of tall pencil

Technical writing should be goal-oriented. It should convey information clearly and include no extraneous material. It should help the reader to find essential information and have a specific format which allows the reader to quickly locate everything in an organised fashion.
You should consider:

  • purpose of document
  • intended audience
  • context

If the audience cannot use, apply or understand the information presented - then the author has failed

Purpose. What is the ultimate goal? This should be practical, the purpose determines the format of your paper. Usually:

  1. Title
  2. Abstract
  3. Introduction
  4. Body
  5. Results
  6. Discussion
  7. Conclusion
  8. Acknowledgments
  9. References

Creative Commons License
Top tips for technical writing by Vince Ricci: CIEE, Joe Schall: Penn State University, Glynis Perkin: Loughborough University, edited by Marion Kelt: GCU is licensed under a Creative Commons Attribution 3.0 Unported License
Based on a work at http://www.slideshare.net/tokyovince/introduction-to-technical-writing-4305074 http://www.slideshare.net/engCETL/technical-report-writing-handout https://www.e-education.psu.edu/styleforstudents/c1_p15.html. Image from slideshare