Technical Writing
-
Upload
douglas-blackley -
Category
Business
-
view
13 -
download
1
description
Transcript of Technical Writing
![Page 1: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/1.jpg)
AboutTechnical Writing
Writing Just Enough
![Page 2: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/2.jpg)
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?
![Page 3: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/3.jpg)
What is “technical writing”?
(and where do you find “technical writers?”)
![Page 4: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/4.jpg)
Technical writing is…
© 2008 Joe Gollner
![Page 5: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/5.jpg)
Technical writing is not…
![Page 6: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/6.jpg)
Technical writing is done to…Purpose
![Page 7: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/7.jpg)
Define and order standard processes…
![Page 8: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/8.jpg)
Ensure critical processes are standardized…
![Page 9: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/9.jpg)
Present accepted norms for understanding & recognizing quality…
![Page 10: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/10.jpg)
Qualify acceptance& rejection metrics…
![Page 11: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/11.jpg)
Simplify complexity…
![Page 12: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/12.jpg)
Codify allowable error and excess in specific environments…
![Page 13: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/13.jpg)
Detail operational necessities…
![Page 14: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/14.jpg)
Reference systems demands and tolerances…
![Page 15: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/15.jpg)
Highlight & describe risk…
![Page 16: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/16.jpg)
Structure available knowledge in support of research…
![Page 17: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/17.jpg)
Identify useful content…
![Page 18: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/18.jpg)
Assemble parts into a whole…
![Page 19: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/19.jpg)
Show the way…
![Page 20: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/20.jpg)
Coordinate functionalities…
![Page 21: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/21.jpg)
Facilitate requirements …
![Page 22: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/22.jpg)
Achieve success
![Page 23: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/23.jpg)
Write 12 volume boEdit
Distribute
How is technical writing done?
![Page 24: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/24.jpg)
Determine purpose of communication
![Page 25: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/25.jpg)
Analyze the audience2
![Page 26: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/26.jpg)
Choose most effective format, organization, and style
3
![Page 27: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/27.jpg)
Collect information4
![Page 28: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/28.jpg)
5. Organize and outline information
![Page 29: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/29.jpg)
Write first draft; then revise and edit
![Page 30: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/30.jpg)
When should technical writing be done?
![Page 31: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/31.jpg)
Officially…
![Page 32: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/32.jpg)
During initial requirements gathering phase of any project
As project requirements are modified
Whenever new versions of existing “deliverables”are contemplated
![Page 33: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/33.jpg)
Normally…
![Page 34: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/34.jpg)
If you want your customers to walk away from product failures….
![Page 35: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/35.jpg)
If you want to reduce customer calls to your technical support team….
![Page 36: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/36.jpg)
If you want customers to “get” your product and become “affiliate” marketing push….
![Page 37: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/37.jpg)
If you want each version of your product to flow smoothly into an established market….
![Page 38: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/38.jpg)
If you want customers who really like your company and your product…….
![Page 39: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/39.jpg)
then technical writing ought to be included in every step of your business plan.
![Page 40: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/40.jpg)
Who does technical writing?
![Page 41: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/41.jpg)
An experienced, professional technical writer
OR
![Page 42: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/42.jpg)
An experienced writerOR
![Page 43: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/43.jpg)
An experienced professional with access to a
professional content editor
![Page 44: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/44.jpg)
How can you know when technical writing is done well?
![Page 45: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/45.jpg)
The intended audience will “tell” you.
> Market share
Vocal brandloyalists
Fewer customer complaints
Fewer product returns
Fewer calls to tech support
Product that works
Positive spin
![Page 46: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/46.jpg)
RecapUse 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.
![Page 47: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/47.jpg)
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
![Page 48: Technical Writing](https://reader034.fdocuments.us/reader034/viewer/2022051411/5456cab2af79592b438b792a/html5/thumbnails/48.jpg)
Please feel freeto let me know what you think
about this presentation.
PowerPoint BureauAt: [email protected]
orplace your comments on Slideshare.
Thanks!