Technical Writing

Slide 1: About Technical Writing Writing Just Enough

Slide 2: Recipe What is “technical” writing? What is it’s purpose? How is technical writing done? When should it be done? Who does technical writing? How can you know when technical writing is done well?

Slide 3: What is “technical writing”? (and where do you find “technical writers?”)

Slide 4: Technical writing is… © 2008 Joe Gollner

Slide 5: Technical writing is not…

Slide 6: Technical writing is done to… Purpose

Slide 7: Define and order standard processes…

Slide 8: Ensure critical processes are standardized…

Slide 9: Present accepted norms for understanding &   recognizing quality…

Slide 10: Qualify acceptance& rejection metrics…

Slide 11: Simplify complexity…

Slide 12: Codify allowable error and excess in specific  environments…

Slide 13: Detail operational necessities…

Slide 14: Reference systems demands and tolerances…

Slide 15: Highlight & describe risk…

Slide 16: Structure available knowledge in support of research…

Slide 17: Identify useful content…

Slide 18: Assemble parts into a whole…

Slide 19: Show the way…

Slide 20: Coordinate functionalities…

Slide 21: Facilitate requirements …

Slide 22: Achieve success

Slide 23: Write 12 volume b o Edit Distribu te How is technical writing done?

Slide 24: Determine purpose of communication

Slide 25: 2 Analyze the audience

Slide 26: 3 Choose most effective format, organization, and style

Slide 27: 4 Collect information

Slide 28: 5. Organize and outline information

Slide 29: Write first draft; then revise and edit

Slide 30: When  should technical       writing be done?

Slide 31: Officially…

Slide 32: During initial requirements  gathering phase of any  project As project           requirements  are modified Whenever new versions  of existing “deliverables” are contemplated

Slide 33: Normally…

Slide 34: If you want your customers to walk away from product failures….

Slide 35: If you want to reduce customer calls to your technical support team….

Slide 36: If you want customers to “get” your product and become “affiliate” marketing push….

Slide 37: If you want each version of your product to flow smoothly into an established market….

Slide 38: If you want customers who really like your company and your product…….

Slide 39: then technical writing ought to be included in every step of your business plan.

Slide 40: Who does technical writing?

Slide 41: An experienced, professional technical  writer OR

Slide 42: An experienced writer OR

Slide 43: An experienced professional  with access to a  professional content editor

Slide 44: How can you know when technical writing is done well?

Slide 45: The intended audience will “tell” you. Fewer calls to  Fewer customer  tech support complaints Vocal brand Fewer product  loyalists returns Product that  Positive spin > Market share works

Slide 46: Recap Use professional technical writers. Start the writing aspects of project when you’re conducting  initial requirements collection. Be ready to provide useful, current information. Follow the “recipe” – K.I.S.S. principle DOES work! Quality of final product is directly related to level of technical  writer involvement in project development.

Slide 47: Millman, Barry, How to Create Great User Documentation: A Hands‐On Course;  IgetItNow Training (Internet Training Program), 2008 Reep, Diane C., Technical Writing: Principles, Strategies, and Readings; 3rd ed.,  Allyn and Bacon, Boston, 1997 Jones, Dan, Technical Writing Style; Allyn and Bacon, Boston, 1998 Gretchen Hargis, Michelle Carey, AnnKilty Hernandez, Polly Hughes, Deirdre Longo,  Shannon Rouiller, Elizabeth Wilde, Developinf Quality Technical Information: A  handbook for Writers and Editors; 2nd ed., IBM Press, Prentice Hall, New Jersey,  2004

Slide 48: Please feel free to let me know what you think about this presentation. PowerPoint Bureau At: blackley.douglas@gmail.com or place your comments on Slideshare. Thanks!