• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Technical Writing
 

Technical Writing

on

  • 2,572 views

Technical writing - http://www.daryabushmakin.com/

Technical writing - http://www.daryabushmakin.com/

Statistics

Views

Total Views
2,572
Views on SlideShare
2,572
Embed Views
0

Actions

Likes
0
Downloads
7
Comments
0

0 Embeds 0

No embeds

Accessibility

Categories

Upload Details

Uploaded via as Microsoft Word

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 Writing Technical Writing Document Transcript

    • DARYA A. BUSHMAKIN, MBA Facebook / Twitter / LinkedIn / Pinterest / Instagram / Video Resume / Website / Slideshare 603 689 – 4513 / dbushmakingmail.com TECHNICAL WRITING Adopt convention for naming files, folders, projects translating content or handing project over translators. Analyze audience Use Bolding for separating headings, subheadings, information. Italics is highlight specific words or phrases. Avoid: o Cluttering page. White space can calm the readers. o Long, run-on sentences modifying clauses. o Nominalizations, sentence structure parallel and misplaced modifiers. o Pompous words. o Slang expressions, jargon, colloquialisms. o Wordiness. Do’s: o Document project design decisions. o Hold notes for future enhancements. o Identify and understand audience. o Store release and dates. o Use white space areas for separating text and visuals. Don’ts: o Be afraid to ask technical, non-technical personnel review work. o Be afraid to repeat self technical writing. Repetition helps reader establish context of material, content is unfamiliar. o Waste users time. Realize that the reader is not expert.Sources: Practices for Agile/Lean Documentation - http://www.agilemodeling.com/essays/agileDocumentationBestPractices.htm Technical Practices Details - http://www.proedit.com/technical_writing_best_practices_1.asp Succeeding Technical Writer - http://www.writing-world.com/tech/tech1.shtml Online Technical - http://www.io.com/~hcexres/tcm1603/acchtml/acctoc.html Tips for Technical - http://www.vendorseek.com/tips-for-technical-writing.asp Five Tips Improve Technical - http://www.writer-on- line.com/content/view/319/66/~s/Technical-Writing/Five-Tips-to-Improve--Technical- Writing.html Technical Tips - http://humanreadable.nfshost.com/howtos/technical_writing_tips.htm Ten Technical Tips - http://freelancefolder.com/ten-great-technical-writing-tips/