4 Matching Annotations
  1. Aug 2023
    1. clear, simple, and easy to understand

      Direct and simple

    2. Technical or workplace writing is intended to solve problems, seek solutions, and provide necessary information that workers will use to, well, solve problems, seek solutions, and provide necessary information.

      Reason why we need Technical writing

    1. First and most important, your writing must be honest. Your trustworthiness in communication reflects not only on you personally but on your organization or discipline. Your writing has to be clear so that your reader can get from it the information you intended. Strive to make sure that you have expressed exactly what you mean, and have not left room for incorrect interpretations. Next, good writing is accurate. Do your homework and make sure you have your facts right. There is no excuse for presenting incorrect information. Also make sure you have all the facts, as your writing must also be complete. Have you included everything that your reader needs? Your audience has neither time nor patience for excessive verbiage, so simplify and cut any clutter. Good writing is always concise writing. Your document should be attractive and pleasing to look at. Just as you wouldn't eat a hamburger from a dirty plate, your reader will not be moved by a document that is not carefully designed and professional.

      Six steps for successful writing (HCACAC) - Honest - Clear - Accurate - Complete - Attractive - Correct

    2. Technical and workplace documents address a specific audience. The audience may be an individual or a group, and it may or may not be known to the writer. While there is always a primary audience addressed, there may be a secondary audience. Thus, an understanding of the reader or user of a technical document is important.

      Such as addressing issues or temporary changes