Measuring the Quality of your Documentation
10
uring the Quality of your Documenta t to you by the STC Europe SIG and STC France …and getting results you can work wit Presented by Alice Jane Emanuel Sponsored by UTC Fire & Security
description
Measuring the Quality of your Documentation. …and getting results you can work with — fast. Presented by Alice Jane Emanuel. Brought to you by the STC Europe SIG and STC France. Sponsored by UTC Fire & Security. What’s in it for you?. - PowerPoint PPT Presentation
Transcript of Measuring the Quality of your Documentation
Measuring the Quality of your Documentation
Brought to you by the STC Europe SIG and STC France
…and getting results you can work with—fast
Presented by Alice Jane Emanuel
Sponsored by UTC Fire & Security
What’s in it for you?
• Improve the user experience of your technical communication product and of the products you write for
• Be localisation ready• Develop your skills• Build your team and develop their
skills• Build knowledge and confidence
Improved quality
What’s in it for you? Information
• Self-audit• Build useful metrics• Address your company’s bottom line• Build knowledge and confidence
What’s in it for you? Spin-off benefits
• Manage corporate pressure• Compete and improve your profile• Manage expectations• Build knowledge and confidence
Categories• Structure• Reference and navigation• Graphics and other visual elements• Accuracy and grammar• Terminology• Consistency• Clarity• Task orientation• Completeness
Results! By category
• Show a learning curve for individuals and the team
• Give individuals solid feedback about what to do to improve their work
• Provide a granular induction to new hires to help them understand the level of work that they can aspire to
• Argue for initiatives such as different media for information delivery
• Show exactly where and how the documentation is improving and what that means for internal and external clients and company revenue
Results! Overall
• Create a documentation team history • Create a project history, this is particularly useful over
several editions of a document set• Show why I need more time for a project• Discuss professional development with my team and
with my boss• Show documentation efficiency—Using this form is
persuasive• Negotiate perks for my team• Show in general where and how the documentation is
improving overall and what that means for internal and external clients and company revenue
• Show my worth to the company
alicejanee
http://nl.linkedin.com/in/alicejaneemanuel
Alice Jane [email protected]
at http://commatheory.com
DownloadDetermining technical document quality
Thank you!STC Europe SIGSTC FranceUTC Fire & Security
the tool:
:: communication for the real world ::
