DOCSLIB.ORG

Guidelines for the Design and Preparation of User Documentation for Application Software

Total Page：16

File Type：pdf, Size：1020Kb

Download full-text PDF Read full-text
Guidelines for the Design and Preparation of User Documentation for Application Software 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
Load more

Recommended publications
  • A4 Paper Format / International Standard Paper Sizes
    A4 paper format / International standard paper sizes International standard paper sizes by Markus Kuhn Standard paper sizes like ISO A4 are widely used all over the world today. This text explains the ISO 216 paper size system and the ideas behind its design. The ISO paper size concept In the ISO paper size system, the height-to-width ratio of all pages is the square root of two (1.4142 : 1). In other words, the width and the height of a page relate to each other like the side and the diagonal of a square. This aspect ratio is especially convenient for a paper size. If you put two such pages next to each other, or equivalently cut one parallel to its shorter side into two equal pieces, then the resulting page will have again the same width/height ratio. The ISO paper sizes are based on the metric system. The square-root-of-two ratio does not permit both the height and width of the pages to be nicely rounded metric lengths. Therefore, the area of the pages has been defined to have round metric values. As paper is usually specified in g/m², this simplifies calculation of the mass of a document if the format and number of pages are known. ISO 216 defines the A series of paper sizes based on these simple principles: ● The height divided by the width of all formats is the square root of two (1.4142). ● Format A0 has an area of one square meter. ● Format A1 is A0 cut into two equal pieces.
    [Show full text]
  • Xerox® Travel Scanner 150 User’S Guide
    One Touch 4.6 August 2012 05-0840-100 Xerox® Travel Scanner 150 User’s Guide Design © 2012 Xerox Corporation. All rights reserved. XEROX®, XEROX and Design® and DocuMate® are registered trademarks of Xerox Corporation in the United States and/or other countries. BR2702 Content © 2012 Visioneer, Inc. All rights reserved. The Visioneer brand name and OneTouch® logo are registered trademarks of Visioneer, Inc. Copyright protection claimed includes all forms of matters of copyrightable materials and information now allowed by statutory or judicial law or hereinafter granted, including without limitation, material generated from the software programs which are displayed on the screen such as styles, templates, icons, screen displays, looks, etc. Reproduction, adaptation, or translation without prior written permission is prohibited, except as allowed under the copyright laws. The PaperPort® and OmniPage® brand name and logo are registered trademarks of Nuance Communications, Inc. Adobe®, Adobe® Acrobat®, Adobe® Reader®, and the Adobe® PDF logo are registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. The Adobe PDF logo will appear in this product’s software, and full access to Adobe software features is only available if an Adobe product is installed on your computer. Microsoft is a U.S. registered trademark of Microsoft Corporation. Windows™ is a trademark and SharePoint® is a registered trademark of Microsoft Corporation. ZyINDEX is a registered trademark of ZyLAB International, Inc. ZyINDEX toolkit portions, Copyright © 1990-1998, ZyLAB International, Inc. Document Version: 05-0840-100 (August 2012). All Rights Reserved. All other products mentioned herein may be trademarks of their respective companies and are hereby acknowledged.
    [Show full text]
  • Long Term Archiving of Digital Data on Microfilm
    Int. J. Electronic Governance, Vol. 3, No. 3, 2010 237 Long-term archiving of digital data on microfilm Steffen W. Schilke* Gemeinsame IT-Stelle der hessischen Justiz Friedrich-Ebert-Straße 28 D-61118 Bad Vilbel, Germany Postal Address: Oberlandesgericht Frankfurt am Main, D-60256 Frankfurt am Main, Germany E-mail: [email protected] *Corresponding author Andreas Rauber Department of Software Technology and Interactive Systems, Vienna University of Technology Favoritenstr., 9-11/188, A-1040 Vienna, Austria E-mail: [email protected] Abstract: E-government applications have to archive data or documents for long retention periods of 100 years or more. This requires to store digital data on stable media, and to ensure that the file formats can be read by available software. Both applications as well as media technology have only short life spans. Thus, data has to be migrated at frequent intervals onto new data carriers and to new file formats. However, original file versions usually need to be retained permanently. In terms of cost, stability and technology independence, microfilm storage offers a promising solution for off-line storage. This paper reports on a feasibility study analysing encoding techniques that allow digital data to be saved onto microfilm, testing data recovery as well as cost issues. Keywords: digital preservation; bit-stream preservation; long-term storage; microfilming. Reference to this paper should be made as follows: Schilke, S.W. and Rauber, A. (2010) ‘Long-term archiving of digital data on microfilm’, Int. J. Electronic Governance, Vol. 3, No. 3, pp.237–253. Biographical notes: Steffen Walter Schilke is working in the field of archiving and document management for more than a decade.
    [Show full text]
  • BCBP Implementation Guide Is Intended to Be Used As Guidance Material When Airlines Would Like to Implement Bar Coded Boarding Pass (BCBP)
    BAR CODED BOARDING PASS (BCBP) IMPLEMENTATION GUIDE Effective Date: 1st June, 2018 Seven Edition Page | 1 DISCLAIMER. The information contained in this publication is subject to constant review in the light of changing government requirements and regulations. No reader should act on the basis of any such information without referring to applicable laws and regulations and/or without taking appropriate professional advice. Although every effort has been made to ensure accuracy, the International Air Transport Association shall not be held responsible for loss or damage caused by errors, omissions, misprints or misinterpretation of the contents hereof. Furthermore, the International Air Transport Association expressly disclaims all and any liability to any person, whether a purchaser of this publication or not, in respect of anything done or omitted, and the consequences of anything done or omitted, by any such person in reliance on the contents of this publication. No part of the Common Use Passenger Processing Systems Implementation Guide may be reproduced, recast, reformatted or transmitted in any form by any means, electronic or mechanical, including photocopying, recording or any information storage and retrieval system, without the prior written permission from: International Air Transport Association 800 Place Victoria, P.O. Box 113 Montreal, Quebec, Canada H4Z 1M1 © IATA 2017 Page | 2 TABLE OF CONTENTS 1. INTRODUCTION ..................................................................................... 6 1.1. Background ..................................................................................................................
    [Show full text]
  • Interoperability Unit
    EUROPEAN RAILWAY AGENCY INTEROPERABILITY UNIT TAP TSI ANNEX B.54 INDIRECT FULFILMENT APPLICATION GUIDE REFERENCE: ERA/TD/2012-09/INT DOCUMENT APPLICATION GUIDE TYPE: VERSION: 1.0 FINAL TAP TSI DATE: 06.12.2013 PAGE 1 OF 28 AMENDMENT RECORD Version Date Section Modification/description number 1.0 DRAFT 01.08.2012 All Import from TAP TSI phase 1 delivery 1.0 FINAL 06.12.2013 All Final publication European Railway Agency ERA/TD/2012-09/INT Annex B.54 of TAP TSI 1 Table of Contents 1 Table of Contents ..................................................................................................... 2 2 Introduction ............................................................................................................... 3 3 References ................................................................................................................ 4 3.1 References ........................................................................................................... 4 4 Particular description of the subject ....................................................................... 5 5 Updating .................................................................................................................... 6 6 Purpose ..................................................................................................................... 7 7 Rights & obligations, actors .................................................................................... 8 8 Travel documents ..................................................................................................
    [Show full text]
  • Iso 690:2010 International Iso Standard 690
    BS ISO 690:2010 INTERNATIONAL ISO STANDARD 690 Third edition 2010-06-15 Information and documentation — Guidelines for bibliographic references and citations to information resources Information et documentation — Principes directeurs pour la rédaction des références bibliographiques et des citations des ressources d'information Reference number ISO 690:2010(E) © ISO 2010 ISO 690:2010(E) PDF disclaimer This PDF file may contain embedded typefaces. In accordance with Adobe's licensing policy, this file may be printed or viewed but shall not be edited unless the typefaces which are embedded are licensed to and installed on the computer performing the editing. In downloading this file, parties accept therein the responsibility of not infringing Adobe's licensing policy. The ISO Central Secretariat accepts no liability in this area. Adobe is a trademark of Adobe Systems Incorporated. Details of the software products used to create this PDF file can be found in the General Info relative to the file; the PDF-creation parameters were optimized for printing. Every care has been taken to ensure that the file is suitable for use by ISO member bodies. In the unlikely event that a problem relating to it is found, please inform the Central Secretariat at the address given below. COPYRIGHT PROTECTED DOCUMENT © ISO 2010 All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from either ISO at the address below or ISO's member body in the country of the requester.
    [Show full text]
  • Duplex Standby Less Than 26 Dba* Noise Level Copying Less Than 56 Dba*3 Dimensions (W X D X H) 400 X 413 X 400 Mm Weight Approx
    Multi-Function Printer Lineup Model DP-MB250CX KX-MB2545CX KX-MB2275CX KX-MB2235CX Copy DP-MB250CX PCL Print GDI Scan KX-MB2545CX Fax 100Base-TX/10Base-T Computer Wi-Fi (IEEE802.11b/g/n) — — — Interface KX-MB2275CX USB USB slot (Host) — — Automatic Document Feeder (ADF) (Auto-reverse) (Auto-reverse) KX-MB2235CX Specifications Model DP-MB250CX KX-MB2545CX KX-MB2275CX KX-MB2235CX Printing Process Laser Cassette: A4, A5, LTR, LGL, 216 x 330 mm, 216 x 340 mm, B5(JIS/ISO), 16K Recording Paper Size Multi-purpose tray/Manual tray: A4, A5, A6, LTR, LGL, B6(JIS/ISO), B5(JIS/ISO), 216 x 330 mm, (Simplex) 216 x 340 mm, 16K, Envelope #10/DL/YOUKEI #4/CHOUKEI #3/CHOUKEI #4, Japanese Post Card, Custom (W: 90-216 mm, L: 200-356 mm) Max: 1050 sheets Max: 501 sheets Recording Paper (Standard Cassette: 500 sheets / Multi-purpose tray: 50 sheets / (Cassette: 500 sheets / Capacity*1 Optional Cassette: 500 sheets) Manual tray: 1 sheet) Capacity 50 sheets High-speed ADF Document Single-sided A4, A5, A6, LTR, LGL, B6(JIS/ISO), B5(JIS/ISO), 216 x 330 mm, 216 x 340 mm, 16K, Long Paper (W 210-216, L356-600 mm) General size Double-sided A4, A5, LTR, LGL, B5(JIS/ISO), 216 x 330 mm, 216 x 340 mm, 16K n/a ppm LCD Display 16 digits / 2 lines (Backlit LCD) 16 digits / 2 lines Memory Size 64 MB 28 Monthly Average 5,000 pages 3,000 pages 1,500 pages duty Maximum 50,000 pages 30,000 pages 15,000 pages Power Consumption Maximum: Approx.
    [Show full text]
  • Publication 28 Contents
    Contents 1 Introduction. 1 11 Background . 1 111 Purpose . 1 112 Scope . 1 113 Additional Benefits . 1 12 Overview . 2 121 Address and List Maintenance . 2 122 List Correction. 2 123 Updates. 2 124 Address Output . 3 125 Deliverability . 3 13 Address Information Systems Products and Services . 3 2 Postal Addressing Standards . 5 21 General . 5 211 Standardized Delivery Address Line and Last Line. 5 212 Format . 5 213 Secondary Address Unit Designators . 6 214 Attention Line . 7 215 Dual Addresses . 7 22 Last Line of the Address. 8 221 City Names . 8 222 Punctuation . 8 223 Spelling of City Names . 8 224 Format . 9 225 Military Addresses. 9 226 Preprinted Delivery Point Barcodes . 9 23 Delivery Address Line . 10 231 Components . 10 232 Street Name . 10 233 Directionals . 11 234 Suffixes . 13 235 Numeric Street Names . 13 236 Corner Addresses . 14 237 Highways. 14 238 Military Addresses. 14 239 Department of State Addresses . 15 June 2020 i Postal Addressing Standards 24 Rural Route Addresses. 15 241 Format . 15 242 Leading Zero . 16 243 Hyphens . 16 244 Designations RFD and RD . 16 245 Additional Designations . 16 246 ZIP+4. 16 25 Highway Contract Route Addresses . 17 251 Format . 17 252 Leading Zero . 17 253 Hyphens . 17 254 Star Route Designations . 17 255 Additional Designations . 18 256 ZIP+4. 18 26 General Delivery Addresses . 18 261 Format . 18 262 ZIP Code or ZIP+4 . 18 27 United States Postal Service Addresses . 19 271 Format . 19 272 ZIP Code or ZIP+4 . 19 28 Post Office Box Addresses. 19 281 Format . 19 282 Leading Zero .
    [Show full text]
  • " Who Controls the Vocabulary, Controls the Knowledge"
    Acronyms from Future-Based Consultancy & Solutions "Translation" of some Business, Finance, ICDT acronyms (including several SAP ones), initialims, tech term oddities and techronyms, loaded words and buzzwords to ease the reading of courses, books, magazines and papers: see "anacronym", "ASS" and many others ... (third main version since 1997) ( www.fbc-e.com , updated & corrected twice a month. Release 02-10-2009) " Who controls the vocabulary , 6170+ controls the knowledge " George ORWELL in "1984" Instruction To ease your researches , we are inviting you to use the " search " function within the Menu " edit " Pour faciliter vos recherches, utilisez la fonction " rechercher " disponible dans le menu " Edition " Information Underligned names are identifying authors, editors and / or copyrighted applications ©, ®, ™ FBWPA Free Business White Page Available (www.fbc-e.com ) Acronym Rose salmon is related to acronyms and assimilated terms and concepts. IL / InLin Internet Lingo also called " PC talk" Intelligence Light green color is related to intelligence, business intelligence ( BI , CI ) FBC>s Yellow color is related to FBC>s concepts and methodologies (more on www.fbc-e.com ) Finance Deep blue color is related to Finance and Accounting ( FI ) Note: BOLD acronyms KM Deep green color is related to Knowledge Management ( KM ) and texts are "translated" HR & R Lemon green color is related to HR and recruitment in the list. Mobility Light blue color is related to mobile communication ( MoMo ) Security Red color is related to security and risks management ( RM ) Note : US spelling Virtual Pink color is related to virtual / virtuality ( VR ) & ampersand $$$ temporary files Feel free to copy and distribute this "computer-babble *.001 Hayes JT Fax translator" provided that it is distributed only in its 0 Day FTP server supposed to be moved within original and unmodified state with our name, address, the next 24 hours to another IP .
    [Show full text]
  • Su Acceso a Las Normas Internacionales #100
    #100 focusSu acceso a las Normas Internacionales Cambio positivo ISOfocus Septiembre/Octubre 2013 ISSN 2226-1095 ISOfocus iahora se publica seis veces al año. Usted puede descubrir mayor contenido en 6 nuestro sitio Web en iso.org/isofocus, o manteniédose conectado con nosotros en: TWITTER FACEBOOK googleplusYoutubeFlickr Director de Marketing, Comunicación e Información | Nicolas Fleury Jefe de Comunicación y Estrategia de Contenidos | Katie Bird KB Editor en jefe | Elizabeth Gasiorowski-Denis EGD Editores | Maria Lazarte ML, Sandrine Tranchard ST Redactora y Correctora | Vivienne Rojas Diseñadores | Xela Damond, Pierre Granier, Alexane Rosa Traductores | Denys Crapon de Caprona, Cécile Nicole Jeannet, Anita Rochedy, Catherine Vincent Traducción al español: COPANT (Comisión Panamericana de Normas Técnicas) www.copant.org Colaborador externo a esta edicion | Garry Lambert GL Suscripciones y ediciones anteriores Si le gusta ISOfocus, puede suscribirse, obtener la aplicación y descargar el archivo pdf de forma gratuita, o comprar números en copias impresas a través de nuestro sitio iso. 28 org/isofocus. También puede ponerse en contacto con nuestro servicio de atención al cliente en [email protected]. Contribuciones Usted puede participar en la creación de esta revista. Si cree que su contribución puede aportar un valor añadido a cualquiera de nuestras secciones, por favor póngase en contacto en [email protected]. 20 Todo el contenido de esta revista es © ISO, 2013. Ninguna parte puede ser reproducida sin el permiso previo por escrito de la editorial. Si desea hacerlo, por favor contactese con nosotros [email protected]. Las opiniones expresadas son las de los respectivos contribuyentes y no son necesariamente las de ISO o de cualquiera de sus miembros.
    [Show full text]
  • Network Working Group R. Smith Request for Comments: 1759 Texas Instruments Category: Standards Track F
    Network Working Group R. Smith Request for Comments: 1759 Texas Instruments Category: Standards Track F. Wright Lexmark International T. Hastings Xerox Corporation S. Zilles Adobe Systems, Inc. J. Gyllenskog Hewlett-Packard Company March 1995 Printer MIB Status of this Memo This document specifies an Internet standards track protocol for the Internet community, and requests discussion and suggestions for improvements. Please refer to the current edition of the "Internet Official Protocol Standards" (STD 1) for the standardization state and status of this protocol. Distribution of this memo is unlimited. Table of Contents 1. Introduction ................................................ 3 1.1 Network Printing Environment ............................... 3 1.2 Printer Device Overview .................................... 4 1.3 Categories of Printer Information .......................... 5 1.3.1 Descriptions ............................................. 5 1.3.2 Status ................................................... 5 1.3.3 Alerts ................................................... 5 2. Printer Model ............................................... 6 2.1 Overview of the Printer Model .............................. 8 2.2 Printer Sub-Units .......................................... 8 2.2.1 General Printer .......................................... 8 2.2.2 Inputs ................................................... 9 2.2.3 Media .................................................... 9 2.2.4 Outputs .................................................
    [Show full text]
  • Tabulation of Voluntary Standards and Certification Programs for Consumer Products
    * °F ^ °o< 3 NBS TECHNICAL NOTE 948 \ / ^f^Tof U.S. DEPARTMENT OF COMMERCE/ National Bureau of Standards mmBBnonHiMBi NATIONAL BUREAU OF STANDARDS 1 The National Bureau of Standards was established by an act of Congress March 3, 1901. The Bureau's overall goal is to strengthen and advance the Nation's science and technology and facilitate their effective application for public benefit. To this end, the Bureau conducts research and provides: (1) a basis for the Nation's physical measurement system, (2) scientific and technological services for industry and government, (3) a technical basis for equity in trade, and (4) technical services to pro- mote public safety. The Bureau consists of the Institute for Basic Standards, the Institute for Materials Research, the Institute for Applied Technology, the Institute for Computer Sciences and Technology, the Office for Information Programs, and the Office of Experimental Technology Incentives Program. THE INSTITUTE FOR BASIC STANDARDS provides the central basis within the United States of a complete and consist- ent system of physical measurement; coordinates that system with measurement systems of other nations; and furnishes essen- tial services leading to accurate and uniform physical measurements throughout the Nation's scientific community, industry, and commerce. The Institute consists of the Office of Measurement Services, and the following center and divisions: Applied Mathematics — Electricity — Mechanics — Heat — Optical Physics — Center for Radiation Research — Lab- 2 2 2 3 oratory Astrophysics — Cryogenics — Electromagnetics — Time and Frequency . THE INSTITUTE FOR MATERIALS RESEARCH conducts materials research leading to improved methods of measure- ment, standards, and data on the properties of well-characterized materials needed by industry, commerce, educational insti- tutions, and Government; provides advisory and research services to other Government agencies; and develops, produces, and distributes standard reference materials.
    [Show full text]