ISO/IEC JTC 1/SC 7 Date: 2003-03-04 ISO/IEC FDIS 18019:2003(E) ISO/IEC JTC 1/SC 7/WG 2 Secretariat: Software and systems engineering — Guidelines for the design and preparation of user documentation for application software Élément introductif — Élément central — Élément complémentaire Document type: International Standard Document subtype: Document stage: (50) Approval Document language: E Macintosh HD2:Users:cinzia:Documents:AccessAbility SIG work:ISO-IEC_FDIS_18019_(E).doc STD Version 2.1 ISO/IEC FDIS 18019:2003(E) Copyright notice This ISO document is a Draft International Standard and is copyright-protected by ISO. Except as permitted under the applicable laws of the user's country, neither this ISO draft nor any extract from it may be reproduced, stored in a retrieval system or transmitted in any form or by any means, electronic, photocopying, recording or otherwise, without prior written permission being secured. Requests for permission to reproduce should be addressed to either ISO at the address below or ISO's member body in the country of the requester. ISO copyright office Case postale 56 • CH-1211 Geneva 20 Tel. + 41 22 749 01 11 Fax + 41 22 749 09 47 E-mail [email protected] Web www.iso.org Reproduction may be subject to royalty payments or a licensing agreement. Violators may be prosecuted. iii © ISO/IEC 2003 — All rights reserved ISO/IEC FDIS 18019:2003(E) Contents Page Foreword....................................................................................................................................................................ix Introduction................................................................................................................................................................x 1 Scope.............................................................................................................................................................1 2 Terms and definitions .................................................................................................................................2 3 Overview........................................................................................................................................................8 3.1 Forms of documentation ............................................................................................................................8 3.2 Deciding what form of documentation to use .........................................................................................9 3.2.1 General ..........................................................................................................................................................9 3.2.2 Information that needs to be on the screen...........................................................................................10 3.2.3 Information that generally needs to be on paper..................................................................................10 3.3 Overview of the structure of this Standard............................................................................................11 3.3.1 General ........................................................................................................................................................11 3.3.2 Checklists ...................................................................................................................................................12 4 The objectives phase ................................................................................................................................13 4.1 General ........................................................................................................................................................13 4.2 Collect and interpret project requirements and constraints...............................................................13 4.2.1 General ........................................................................................................................................................13 4.2.2 Product objectives.....................................................................................................................................14 4.2.3 Sales objectives .........................................................................................................................................15 4.2.4 Scheduling objectives...............................................................................................................................15 4.2.5 Usability objectives ...................................................................................................................................16 4.2.6 Accessibility objectives............................................................................................................................16 4.2.7 Modification requirements .......................................................................................................................16 4.2.8 Internationalisation and national cultural requirements......................................................................17 4.2.9 Translation requirements .........................................................................................................................17 4.2.10 Packaging requirements...........................................................................................................................18 4.2.11 Legal requirements....................................................................................................................................18 4.2.12 Security .......................................................................................................................................................19 4.2.13 Standards and conventions .....................................................................................................................19 4.2.14 Cost constraints.........................................................................................................................................20 4.2.15 Documentation delivery and viewing mechanisms..............................................................................20 4.2.16 Quality management .................................................................................................................................20 4.2.17 Provision of technical information..........................................................................................................20 4.2.18 Approval authorities..................................................................................................................................21 4.2.19 Configuration management......................................................................................................................21 4.2.20 Availability of resources...........................................................................................................................22 4.3 Documentation Proposal..........................................................................................................................22 5 The planning phase ...................................................................................................................................24 5.1 General ........................................................................................................................................................24 5.2 Documentation plan ..................................................................................................................................25 5.2.1 General ........................................................................................................................................................25 5.2.2 Standards....................................................................................................................................................25 5.2.3 Version control and change control .......................................................................................................25 5.2.4 Personnel ....................................................................................................................................................26 5.2.5 Equipment...................................................................................................................................................26 iv © ISO/IEC 2003 — All rights reserved ISO/IEC FDIS 18019:2003(E) 5.2.6 Responsibilities..........................................................................................................................................27 5.2.7 Cost estimates............................................................................................................................................27 5.2.8 Schedules....................................................................................................................................................29 5.2.9 Prototypes and drafts................................................................................................................................29 5.2.10 System tests ...............................................................................................................................................30 5.2.11 Reviews........................................................................................................................................................30 5.2.12 Usability testing..........................................................................................................................................31