इंटरनेट मानक Disclosure to Promote the Right To Information Whereas the Parliament of India has set out to provide a practical regime of right to information for citizens to secure access to information under the control of public authorities, in order to promote transparency and accountability in the working of every public authority, and whereas the attached publication of the Bureau of Indian Standards is of particular interest to the public, particularly disadvantaged communities and those engaged in the pursuit of education and knowledge, the attached public safety standard is made available to promote the timely dissemination of this information in an accurate manner to the public. “जान1 का अ+धकार, जी1 का अ+धकार” “प0रा1 को छोड न’ 5 तरफ” Mazdoor Kisan Shakti Sangathan Jawaharlal Nehru “The Right to Information, The Right to Live” “Step Out From the Old to the New” IS 13553 (1993): User Documentation and Cover Information for Consumer Software Packages for Information Processing Systems [LITD 14: Software and System Engineering] “!ान $ एक न’ भारत का +नम-ण” Satyanarayan Gangaram Pitroda ““IInnvveenntt aa NNeeww IInnddiiaa UUssiinngg KKnnoowwlleeddggee”” “!ान एक ऐसा खजाना > जो कभी च0राया नहB जा सकता हहहहै””ै” Bhartṛhari—Nītiśatakam “Knowledge is such a treasure which cannot be stolen” SI 13553 : 1993 IS0 9127 : 1988 Indian Standard RESU NOITATNEMUCOD DNA REVOC NOITAMROFNI ROF REMUSNOC SO,FTWARE SEGAKCAP ROF NOITAMROFNI GNISSECORP SMETSYS UDC 60’3’186 @ SIB 3991 BUREAU OF INDIAN STANDARDS KANAM ,NAVAHB 9 RUDAYAB HAHS RAFAZ GRAM NEW IHLED 200011 February 1993 Price Group 4 Information Systems and Software Sectional Committee, LTD 33 NATIONAL FOREWORD This Indian Standard which is identical with IS0 9127 : 1988 ‘Information processing systems - User documentation and cover information for consumer software packages’ issued by the International Organization for Standardization ( IS0 ) was adopted by the Bureau of Indian Standards on the recommendations of Information Systems and Software Sectional Committee ( LTD 33 ) and approval of the Electronics and Telecommunication Division Council. In the adopted standard certain terminology and conventions are however not identical to those used in Indian Standards. Attention is particularly drawn to th? following: Wherever the words ‘International Standard’ appear referring to this standard, they should be read as ‘Indian Standard’, In this Indian Standard, the following international standard is referred to. Read in its place the following: International Standard Indian Standard IS0 6592 Information processing - Guidelines IS 13394 : 1992 Guidelines for the docu- for the documentation of computer-based mentation of computer-based application application systems systems for information processing ( Identical ) IS 13553 : 1993 IS0 9127 : 1988 Indian Standard USER DOCUMENTATION AND COVER NOITAMROFNI ROF CONSUMER SOFTWARE SEGAKCAP FCR NOITAMROFNI GNISSECORP SMETSYS 0 Introduction tation which describes the content of the software as opposed to its use. Manufacturers produce this documen- Consumer software packages are ready-made packages sold tation in order to be able to adequately support the soft- off-the-shelf to the consumer. Typically the software is sold ware, but in order to protect their proprietary interests, they pre-wrapped with its user documentation. will not normally release it to the consumer. The information provided in the user uocumentation on the This International Standard does not give guidance on how the cover of the package is often the only means whereby the information should be presented, nor does the ordering given manufacturer or marketing organization can communicate with to information in this International Standard imply a prescribed tI the consumer and uset. is therefore vitally irnportant that suf- order for the information content of the documentation of an ficient information is given to enable the consumer to use the individual package. software successfully. This International Standard is applicable to software packages sold off-the-shelf to consumers for business, scientific, edu- 1 Scope and field of application cational and home use. This International Standard describes the user documentation and cover information supplied with consumer software : 2 References packages -- User documentation IS0 ,2956 Information processing - Guidelines for the documentation of computer-based application systems. This documentation provides users with all the information they need to install and run the softw a re. Typically this IS0 7185, Programming languages - PASCAL. documentation takes the form of one or more manuals included with the software inside the wrapping. As a result, users are not able to consult the manual(s) until they have bought the package. 3 Definitions User documentation is described in section one of this Inter- For the purpose of this International Standard the following national Standard. : definitions apply ~~ Cover information This is information given on the external wrapping of the 32.1 consumer software package: A software product package. Its purpose is to enable prospective purchasers to designed and sold to carry out identified functions; the soft- decide on the applicability of the software to their re- ware and its associated documentation are packaged for sale as qulremerits. a unit. Covet information is described In section two of this Inter national Standard. 3.2.2 consumer: The organization or person who buys the software package. This InternatIonal Standard does not cober - Matketiny literature. 3.2.3 end user; The person who uses the software package The brochures dna leaflets whose purpose is ot pro mote eht .egakcap 3.2.4 manufacturer: The organization which develops tht: software package. .- Technical descnptions fo eht software All eht system, program 41r1; atad documcntatlnn required 3.2.5 marketing organization: :chP no!tazlnayro whictl ot malnfain aricl entlanre eht software, i.e eht documen- rnarkets eht eravhfos .egakcap IS 13553 : 1993 IS0 9127 : 1998 3.2.6 supplier: The organization which sells the software 4 Categories of information package to the consumer. Throughout this International Standard three categories of : information have been identified 3.2.7 software support: The act of maintaining the soft- al Essential ware and its associated documentation in a functional state. Information supplied with every package; NOTE - Software support may be given by the manufacturer, b) Conditional marketing orgenization, supplier or other organization. In special contractually-agreed cases, consumers may be permitted to maintain Information supplied with every package to which it is or enhance the software themselves. relevant; c) Optional 3.2.6 environment: The configuration(s) of hardware and Information supplied at the discretion of the manufac- software in which the software operates. turer or marketing organization. For example, the type(s) of computer, operating system, other Annotations (ESS), (CON) and (OPT) identify essential, con- software and peripherals for which the software is designed. ditional and optional information respectively. IS 13553 : 1993 . IS0 9127 : 1988 Section one : User documentation (ESS) 5 Purpose 6.1.4 Dates (ES!9 The purp~.~eo f user documentation is to provide the end user The release date of the original and current versions shall be with sufficient information for a clear understanding of given. a) the purpose, functions and characteristics of the soft- 6.1.6 Manufacturer or marketing organization (ESS) ware; b) how to install and use the software; The name and address of the manufacturer or the organization which markets the software package shall be given. c) contractual rights and responsibilities. NOTE ~ It is recommended that identification items 6.1.1 to 6.1.5 be The documentation shall include reference documentation, for displayed to the user whenever the software is loaded. Identification day-to-day use with the software. Optionally it may include information displayed on the screen must be consistent with the identi teaching documentation, designed to teach users how to use fication information yven in the reference documentation. the software. It may also include cards, booklets or screen- ( based information giving a summary of the operating instrue tions and commands. 6.1.6 Key words (OPT) Where necessary, supplements to the documentation may be Key words or descriptors which characterize the package and issued; for example : which could be used for indexing or retrieval purposes shall be given. For example; “word processing”, “spreadsheet”, “data- ~.- documentation errata; base management”, “simulation game”. - lists of identified but not covered errors in the software product, with descriptions of known consequences. 6.1.7 Language (OPT) Documentation may be supplied as hard copy or on an elec- The language used for the software user interface and for the trdnic or other medium. user documentation shall be identified (for example Japanese, French, English). 6 Reference documentation (ESS) 6.2 Components of the package (ESS) Reference documentation shall give a sufficiently clear and comprehensive account to permit the end user to set up, install 6.2.1 Items supplied (ESS) and use the software successfully. Where relevant, examples and illustrations s hall be given and All physical items supplied in the package (for example disks, any abbreviations and symbols used in the docum entation shall cassettes, manuals, etc.) shall be listed and identified by name be defined. and quantity. Instructions shall also be included on how to use the reference Where relevant, the contents of the physical items (for example documentation. the programs supplied on the disks or cassettes, the docu- ments included in the manuals, etc.) shall be identified. 6.1 identification of the package (ESS) 6.2.2 Associated items (CON) 6.1.1 Package name and code (ESS) Any associated software, hardware or documentation which The title or name which identifies the package and subtitle may be relevant but which is not included with the package which indicates its functions shall be given. The product code shall be briefly described. The supplier details and order or reference number of the package shall also be given. number of any such item shall also be given. 6.1.2 Variant (CON1 6.3 Functional description of the software (ESS) Additional identification for any package having two or more current variants (for example for different equipment or 6.3.1 Purpose and field of application (ESS) operating system) shall be given. The purpose of the software and the functions It performs shall 6.1.3 Version (CON) be described. The extent of its functions shall be clarified, and, if necessary, any related functions that it does not perform shall The version identification of the software, where applicable, be identified. Where the software consists of more than one together with an explanation of the version numbering system program, the purpose and function(s) tit each component pro- shall be given. gram shall be described. 3 IS 13653 : 1993 IS0 9127 : 1988 Examples of the field of application of the software shall be 6.3.5 Security (CON) given. Any security facilities provided to permit the user to protect the If necessary, the special and distinguishing features of the soft- software or its component programs and data from unauthor- ware, planned future revisions, etc. shall be described. ized access shall be described. Any audit features and data backup facilities shall also be 6.3.2 Environment (ESSI described. a) Hardware requirements (ESS) 6.4 installing the software MS1 The hardware configuration(s) needed to run the soft- ware, including memory requirements, shall be speci- 6.4.1 Installation (ESS) fied. If appropriate, reference shall be made to cor- responding documentation. Any necessary information for the installation of the software b; the end user, describing all actions necessary to introduce b) Software requirements (CON) the software into its operating environment, for example con- necting a printer, ente!ing a printer specification, entering The names, variants, versions and dates of any other master file data, running test software, etc., shall be given. software needed to run the software, with reference to the corresponding documentation, shall be given. 6.4.2 Creating backup copies (CON) c) Communications requirements (CON) A description shall be provided on how to create backup copies The communications interface to other systems shall be of the software, if backup copies are permitted. described. 6.4.3 Software modification (CON] The protocol used shall be identified and any necessary associated information given. If the user has to modify the software for particular environments or usages, the necessary information for this to The character set or communications code used shall be done shall be given. be identified and any exceptions or special codes listed. d) Other requirements (CON) 6.5 Using the software (ESS) Any other environmental requirements shall be de- Complete information for the use of the software, covering scribed. a) preparation for use; 6.3.3 Characteristics (CON) b) input commands and data; a) Performance characteristics (CON) c) software functions; Quantitative information for typical examples, such as d) the resulting output: performance data and level of accuracy, shall be given. e) fault and error messages, and remedial and recovery b) Program size (OPT1 actions: The total program size in commonly used units shall be shall be given. stated (for example bytes, lines of source code). Preparation, input, processing, output and errors may be c) Processing speed (OPT) described function by function or collectively, as appropriate. Information on processing speed (for example speed of Typical examples to help the user understand the operation of compilation, sorting time, communications speed, the software, including sample listings and displays of data and retrieval time, response time) shall be provided. results shall be given. 6.3.4 Restrictions ICON) 6.5.1 Loading the software IESS) Any restrictions on the use of the software or its components InstructIons for loading the software into the cdmputer shall be programs shall be specified. given. Where preliminary actions are required, such as loading an operating system, instructions shall be provided or reference It shall be stated whether the software is copy-protected. made to associated documentation. 4 IS 13553 : 1993 IS0 9127 : 1988 6.6.2 Control instructions, commands or language rules Any restrictions, for example maximum number of (ESS) records per file, maximum number of files per disk, shall be described. a) Control instructions and commands (ESS) 6.6.4 Processing (CON1 The format and function of all control instructions or commands shall be clearly specified. Any restrictions on A brief description of functions carried out by the software in their use, such as mode of operation, input conditions response to input commands, instructions and data shall be and input sequences, shall also be specified. given, if necessary, for the user’s understanding of the oper- ation of the software. b) Output messages (ES!9 The messages displayed in response to control 6.6.6 Errors and faults (ESS) instructions or commands shall be listed. If the messages are not self-explanatory, their meaning shall All errors and fault conditions, and associated messages shall be described. Any actions to be taken by the user in be described. All remedial actions for all errors and faults shall response to the messages shall also be described. also be given. cl Programming language rules (CON) 6.8 Software technical information (CON) For compilers the rules of the language shall be de- scribed by reference to associated documentation (for For some types of packages, for example scientific software, it example IS0 7185 for PASCAL). may be necessary to give technical information relating to the software, for example language used, software structure, algo- rithms used, etc. 6.53 Data (ESSI 6.6.1 Language (CON) a) Input data (CON) The content, logical structure and format of the input If the user needs this information, for example to combine the data, including the meaning of each element, shall be product with other software, the programming language shall described. Any dependence of the data on particular be specified preferably by reference to the appropriate stan- properties of the data medium shall also be described. dard. Additionally, the name, variant, version and supplier of the compiler or interpreter shall be given. If other equipment or software is required to prepare input data for the software, for example for the creation It shall be stated whether any exceptions to the language stan- of files, the requirements shall be fully specified. dard have been adopted. b) Auxiliary data (CON) 6.6.2 Problem solution principles and algorithms (OPT) Any auxiliary data required for the operation of the soft- The theoretical principles, methods of solution and algorithms ware, for example a dictionary for word processing used in connection with the specified functions and with the software, shall be described. structural organization of the program(s) shall be described. Relevant literature references shall also be given. cl Output data fESSI Details of any special interpretation of characters or combi- The content and format of displays, printouts and any nation of characters applicable to the solution of the problem, other form of output data shall be described. Illus- especially concerning prefixes, suffixes, signs, accuracy, trations of sample output shall be given. rounding, coordinate systems and value ranges shall be given. d) Intermediate data (CON) 6.6.3 Software structure (OPT) The content and format of any intermediate data shall be described, when necessary, for the user’s under- The organization of the software units (for example program, standing of the operation of the software. modules, segments, common storage areas) shall be de- scribed. e) Restrictions on data (CON) The presentation may be made graphically, for example by a Any restrictions on data, for example limit on number tree structure diagram, or by an appropriately structured size, shall be described. textual description, and may contain the unit names, their entry points and interfaces, as well as their inter-relationships. f) Data storage (CON) File and record formats shall be described if necessary, 6.7 Testing (OPT) for the user’s understanding of the operation of the software. It shall be stated whether the formatting per- Any methods used to test the software package functions, with mits use of the files and records by other software. sample inputs and expected outputs, shall be described. 5