Class notes for 9/3

Class notes for 9/3

Q: What is technical writing?

A: Any form of concise and specific writing that effectively communicates and enable readers to understand a proof or concept in a variety of technical fields.

The 8 characteristics of writing:

  • Honesty
  • Clarity
  • Accuracy
  • Comprehensive
  • Accessibility/Availability
  • Conciseness
  • Professional appearance
  • Correctness

Examples of technical documents/writing:

  • Emails/CVs
  • Resumes
  • Letters
  • Reports
  • Power points
  • Psuedo-code
  • Notes
  • Tutorials
  • Manuals
  • Portable Document Format (PDF)