AboutTechnical Writing

Writing Just Enough

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?

What is “technical writing”?

(and where do you find “technical writers?”)

Technical writing is…

© 2008 Joe Gollner

Technical writing is not…

Technical writing is done to…Purpose

Define and order standard processes…

Ensure critical processes are standardized…

Present accepted norms for understanding &  recognizing quality…

Qualify acceptance& rejection metrics…

Simplify complexity…

Codify allowable error and excess in specific environments…

Detail operational necessities…

Reference systems demands and tolerances…

Highlight & describe risk…

Structure available knowledge in support of research…

Identify useful content…

Assemble parts into a whole…

Show the way…

Coordinate functionalities…

Facilitate requirements …

Achieve success

Write 12 volume boEdit

Distribute

How is technical writing done?

Determine purpose of communication

Analyze the audience2

Choose most effective format, organization, and style

3

Collect information4

5. Organize and outline information

Write first draft; then revise and edit

When  should technical      writing be done?

Officially…

During initial requirements gathering phase of any project

As project          requirements are modified

Whenever new versions of existing “deliverables”are contemplated

Normally…

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

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

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

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

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

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

Who does technical writing?

An experienced, professional technical writer

OR

An experienced writerOR

An experienced professional with access to a 

professional content editor

How can you know when technical writing is done well?

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

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.

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

Please feel freeto let me know what you think

about this presentation.

PowerPoint BureauAt: blackley.douglas@gmail.com

orplace your comments on Slideshare.

Thanks!