Loading…

Flash Player 9 (or above) is needed to view presentations.
We have detected that you do not have it on your computer. To install it, go here.

Like this document? Why not share!

Technical tien 02

on

  • 158 views

 

Statistics

Views

Total Views
158
Views on SlideShare
158
Embed Views
0

Actions

Likes
0
Downloads
0
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

Technical  tien 02 Technical tien 02 Document Transcript

  • Technical Writing Tips and TricksTechnical writing is a fabulous career for anyone who loves research and writing. If you have a degree in accounting,engineering, biotechnology, or computer technology, consider becoming a technical writer (technical author in the UK). Youdont necessarily need a degree to become a technical writer but it doesnt hurt. The alternative is to get a technical writi ngcertificate. Its imperative to know how to write for technical and non-technical audiences. If youre able to convey informationto both of these audiences, youll have a successful career as a technical writer.Tech notesTech notes BlogTechnical Writing Tips and TricksKnow your target audience. Are you writing for a technical or non-technical audience? These are two different audiences.One will understand technical jargon and the other wont. Make sure you use verbiage that the end user will understand.What is your writing goal? You can write the most comprehensive manual or users guide but if you get lost in the details,your goal will be lost in translation! Dont get lost in the details. Step back from your work and look at the big picture. D oesyour writing make sense? Will the target audience understand what you wrote? If focus solely on the details your messagewill get lost. Review your writing now and again to make sure youre on track with your writing goal.Use examples. Help the end user out by using examples. You may understand the information back and forwards but dontassume the end user will. Provide examples within your writing, especially if youre technical writing is for computer software.Make sure the examples are relevant and the audience can understand them.Give credit to your resources. Do you remember when you had to write research papers and were required to quotesources and provide a bibliography? Make sure you reference any resources you use. Give credit whenever you can.Use visuals. Most people are visual and will appreciate a table of contents, graph, or chart. Use these whenever you canbecause it will help the end user understand the information quickly.Proofread your work. If you dont have an editor or manager proofreading your work, make sure you proofread. It can beembarrassing for a company to send out a manual or guide thats filled with errors. Youd be surprised by the amount oferrors found in newspapers, magazines, newsletters, books, brochures, and other writings. Ask someone to proofread yourwork to make sure all errors are found and corrected.Have someone review your work. Constructive criticism can improve your technical writing skills. Dont be afraid to get asecond opinion. Its good to have a different perspective because you may have missed something or discover a new way ofpresenting information.Use headers. Headers are a great way to break up your writing and it will make reading a long manual or report easier. Useheaders that are relevant to the topic; summarize each section.Stay present. Use present instead of future tense -- its clear and concise. For example, if youre writing a manual for a TV,write, "Press the Menu Button and Select Language. Choose your language." This sentence gets to the point and the enduser immediately knows and understands what to do. Return to Event