1 / 10

Measuring the Quality of your Documentation

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?.

darius
Download Presentation

Measuring the Quality of your Documentation

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. 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

  2. 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

  3. What’s in it for you? Information • Self-audit • Build useful metrics • Address your company’s bottom line • Build knowledge and confidence

  4. What’s in it for you? • Manage corporate pressure • Compete and improve your profile • Manage expectations • Build knowledge and confidence Spin-off benefits

  5. Categories • Structure • Reference and navigation • Graphics and other visual elements • Accuracy and grammar • Terminology • Consistency • Clarity • Task orientation • Completeness

  6. Results! • 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 By category

  7. Results! • 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 Overall

  8. Download the tool: Determining technical document quality at http://commatheory.com Thank you! STC Europe SIG STC France UTC Fire & Security Alice Jane Emanuel alicejanee@commatheory.com :: communication for the real world :: alicejanee http://nl.linkedin.com/in/alicejaneemanuel

More Related