ISO/ INTERNATIONAL STANDARD IEC/IEEE 26514 First edition 2022-01 Systems and software engineering Design and development of information for users Ingenierie du logiciel et des systemes - Conception et développement d'informations pour les utilisateurs IEC Reference number IS0/IEC/IEEE 26514:2022(E) IEEE @IS0/IEC2022 @IEEE2022 IS0/IEC/IEEE 26514:2022(E) COPYRIGHTPROTECTEDDOCUMENT @IS0/IEC2022 @ IEEE2022 All rights reserved. Unless otherwise specified, or required in the context of its implementation, no part of this publication may be reproduced or utilized otherwise in any form or by any means, electronic or mechanical, including photocopying, or posting on the internet or an intranet, without prior written permission. Permission can be requested from either ISO or IEEE at the ISO copyright office Institute of Electrical and Electronics Engineers, Inc CP 401 : Ch. de Blandonnet 8 3 Park Avenue, New York CH-1214 Vernier, Geneva NY 10016-5997, USA Phone: +41 22 749 01 11 Fax: +41 22 749 09 47 Email: [email protected] Email: [email protected] Website: www.iso.org Website: www.ieee.org Published in Switzerland ii @ IS0/IEC 2022 - All rights reserved @ IEEE 2022 - All rights reserved IS0/IEC/IEEE 26514:2022(E) Contents Page Foreword vi Introduction .vii 1 Scope. .1 2 Normative references. .2 3 Terms, definitions and abbreviated terms .2 3.1 Terms and definitions 2 3.2 Abbreviated terms. 8 4 Conformance .9 5 Information management process. 10 5.1 General 10 5.2 Planning the information-development project 11 5.3 Managing the information-development project. 11 6 Information architecture and development .12 6.1 Project requirements, objectives, and constraints .12 6.1.1 General. 12 6.1.2 Project objectives and goals 12 6.1.3 Requirements on information for users 12 6.1.4 Constraints on information for users 13 6.1.5 Project infrastructure and tools 14 6.1.6 Schedule constraints 14 6.1.7 Users and usability objectives. 15 6.2 Audience and task analysis.. 16 6.2.1 General 16 6.2.2 Audienceanalysis 16 6.2.3 Task analvsis 18 6.3 Development 21 6.3.1 Information gathering 22 6.3.2 Developing information for users 6.4 Review.. 223 6.5 Prototypes and drafts 6.6 Content management during development. 6.7 Translation considerations in design and development 忆忆 6.8 Final assembly and review.. Packaging .55 6.9 6.10 Release. 6.11 Updating and maintenance. 55 6.12 Version control and change control 7 Information quality .26 7.1 General .26 7.2 Correctness. .26 7.3 Consistency .26 7.4 Comprehensibility .26 7.5 Conciseness 26 7.6 Minimalism. 27 7.7 Accessibility 27 8 Structure of information for users 27 8.1 Overall structure. .27 8.2 Modularity .27 8.3 Structuring by function 28 8.4 Information model 28 8.5 Structure of conceptual information. 30 @ IS0/IEC 2022 - All rights reserved ii @ IEEE 2022 - All rights reserved IS0/IEC/IEEE26514:2022(E) 8.6 Structure of instructional information. 30 8.7 Structure of reference information. 31 8.8 Structure of commands 32 8.9 Structure of troubleshooting information 32 8.10 Structure of error messages. 32 8.11 Glossary of terms.. 32 8.12 Structure of printed information for users 33 8.13 Structure of online information for users. 33 8.14 User-generated content. 33 8.14.1 General 33 8.14.2 Goals and practices.. 34 8.15 Application programming interfaces (API) 35 8.15.1 General 35 8.15.2 Providing information about an API 36 8.15.3 Structure of the API reference. 37 8.16 Frequently asked questions (FAQ) .38 8.17 Chatbots and voice response systems 39 9 Format of information for users .40 9.1 General 40 9.2 Consistent format. 40 9.3 Selection of appropriate media and format 41 9.3.1 Comparison of formats and media 41 9.3.2 Use of printed or electronic information for users. 42 9.3.3 Relationship of information displays to the application's displays. 42 9.4 Context-sensitive information. 43 9.5 Accessible information for users. 44 9.5.1 Understandable information for users. .44 9.5.2 Information for users