1 / 22

Implementing ISO/IEC 26514 in your workplace

Implementing ISO/IEC 26514 in your workplace. (And why should technical communicators care about standards, anyway?) George Hayhoe Mercer University School of Engineering STC Lone Star Community Addison, TX. What will we be talking about tonight?. How are standards developed?

salena
Download Presentation

Implementing ISO/IEC 26514 in your workplace

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. Implementing ISO/IEC 26514 in your workplace (And why should technical communicators care about standards, anyway?) George Hayhoe Mercer University School of Engineering STC Lone Star Community Addison, TX

  2. What will we be talking about tonight? • How are standards developed? • What standards are relevant to technical communicators in industry and in academe? • What are the requirements for implementing ISO/IEC 26514? • What are the benefits of implementing ISO/IEC 26514?

  3. How are ISO/IEC standards developed?

  4. What is a technical standard? • “… [A] formal document that establishes uniform engineering or technical criteria, methods, processes and practices” (Wikipedia) • Issued by a respected, authoritative entity • UL, IEEE • NIST, Standards Council of Canada, BSI • ISO/IEC

  5. ISOspeak lesson 1 • ISO/IEC: International Organization for Standardization/International Electrotechnical Commission • JTC1/SC7: Joint Technical Committee 1, subcommittee 7, responsible for software and systems engineering standards • WG2: Working group 2, responsible for user documentation

  6. What is unique about ISO/IEC standards? • Represent the efforts of experts from a minimum of 5 countries • Iteratively drafted and balloted, with all technical comments resolved • Published by ISO and widely adopted around the world

  7. ISOspeak lesson 2 • Editorial comments • Technical comments • WD: Working draft (not balloted) • CD: One or more committee drafts and ballots • FCD: Final committee draft and ballot • FDIS: Final draft international standard and ballot (no technical comments allowed)

  8. Where does the working draft come from? • Existing organizational, national, or international standards • Book and article descriptions of best practices • Working group discussions about best practices The vast majority of WG members are volunteers.

  9. Schedule for ISO/IEC 26514 • Working draft/committee draft written (May 2006) • Ballot comments resolved (November 2006) • Final committee draft written (December 2006) • Ballot comments resolved (May 2007) • Final draft international standard written (October 2007) • Ballot comments resolved (May 2008) • International standard published (June 2008)

  10. What standards are relevant to technical communicators in industry and in academe?

  11. JTC1/SC7/WG2 suite of standards • 26511: Requirements for managers of user documentation (FCD being prepared) • 26512: Requirements for acquirers and suppliers of user documentation (FCD out for ballot) • 26513: Requirements for testers and assessors of user documentation (awaiting publication) • 26514: Requirements for designers and developers of user documentation (published) • 26515: Developing user documentation in an agile environment (proposed)

  12. What information does ISO/IEC 26514 contain?

  13. First it defines the process. “The first part of this standard covers the user documentation process for designers and developers of documentation. It describes how to establish what information users need, how to determine the way in which that information should be presented to the users, and how to design the information and make it available. It is not limited to the design and development phase of the life cycle, but includes activities throughout the information management and documentation processes.” (p. 1)

  14. Then it defines minimum requirements. “The second part of this standard provides minimum requirements for the structure, information content, and format of user documentation, including both printed and on-screen documents used in the work environment by users of systems containing software. It applies to printed user manuals, online help, tutorials, and user reference documentation.” (p. 1)

  15. There are no surprises. • Best practices in documentation processes reflect Hackos’s Managing Your Information Projects (1994). • Requirements for usability testing reflect Hackos and Redish’s User and Task Analysis for Interface Design (1998) and Barnum’s Usability Testing and Research (2002).

  16. What do we mean by conformance to ISO/IEC 26514 requirements?

  17. How can your organization claim conformance? • An organization may claim conformance for • Its documentation process • Its documents • Both its process and its documents • The standard is meant to be tailored: • To apply to necessary requirements • To apply to cost-effective requirements

  18. Conformance situations • You may claim and document conformance • For the organization • For a project • For a multi-supplier program • For individual documentation products or document sets • You may also use the standard as guidance.

  19. ISOspeak lesson 3 • Shall indicates a binding provision. • Should indicates a recommendation. • Change shall to should if you are using the standard as guidance rather than claiming conformance. • May indicates a permissible course of action.

  20. What are the benefits of implementing ISO 26514?

  21. The standard benefits both industry and academe. • Enhanced credibility and leverage with management • Better prepared graduates • Improved hiring and human resources criteria • Greater consistency of products and processes

  22. Your turn • Questions? • Comments? • Experience with this or other standards?

More Related