Change Location × Austin

    Recent Locations

      5 Tips for Successful Technical Writing Meetup in Austin


      • 5 Tips for Successful Technical Writing Meetup Photo #1
      1 of 1
      November 30, 2018 - December 1, 2018

      Friday   2:30 PM - Saturday 2:00 PM

      5930 Middle Fiskville Rd
      Austin, Texas

      Map
      Performers:
      • No Performers Listed
      EVENT DETAILS
      5 Tips for Successful Technical Writing Meetup

      Careers in information technology require skills that go beyond being able to program in the latest industry-standard code. From documenting business requirements, to defining implementation and test strategies, one of the most useful yet neglected skills is the ability to communicate successfully through writing.

      Here are five tips any IT professional can use to enhance technical writing skills.

      1. Read examples of other work

      Most successful writers claim to be prolific readers, and this habit also serves true in technical writing. Reading others’ work provides examples of everything from organization to style. Imitation is the highest form of flattery, and recognizing good sample documentation is often the starting point to a successful document.

      2. Know the audience
      Technical documentation is read by an audience with varied skill sets, including programmers, end-users, and management. Writing with this audience in mind aids in understanding and garners quick approval. Specific techniques include providing sufficient background information or purpose, reducing technical jargon, or including a glossary to help illustrate terms that may not be familiar to all readers.

      3. Pay attention to format and organization
      Content is a major component of any document, yet meaning is lost if the reader struggles to get past page one. Good technical writing helps the reader get to the end. Attention to format includes using bold and italicized keywords, using bullets and numbered lists to set apart key points, and breaking up long passages of prose into smaller paragraphs. Each technique separates content into digestible chunks which aids comprehension and retention.

      4. Don’t neglect the editing process
      Editing goes beyond relying on spelling and grammar check to eliminate errors. After the initial effort of putting words to paper, the natural instinct is to save and send. However, a second and third review often lends additional perspective and allows the writer to further refine areas requiring improvement. Peer reviews also serve as a useful tool for pointing out weaknesses as well as strengths.

      5. Solicit feedback and practice
      Finally, one of the most important techniques to becoming a better technical writer is to solicit feedback and incorporate suggestions into the next writing project. Much like a peer review, post-writing feedback aids in gauging the success of the document. Being able to successfully set aside ego, and channel feedback and criticism will help improve each successive writing task and eventually lead to becoming an efficient and seasoned technical writer.

      Cost: Free -

      Categories: Education

      Event details may change at any time, always check with the event organizer when planning to attend this event or purchase tickets.