User documentation

Dovesi, R., Sauders, V.R. and Roetti, C. (1992) CRYSTAL92 User documentations, University of Torino. 

Deployment plan From as-is to to-be via a transition plan, including installation scripts, upgrade and migration tools, user documents, user training... 

Updating the system and user documentation must always reflect the implemented change(s). 

Poor operator interface design induces errors and inefficiency among even the best-trained operators, especially under conditions of stress, time constraints, and/or fatigue. Although labeling (e.g., user documentation) is extremely important for good performance, even well-written instructions are cumbersome to use in conjunction with actual operation. In addition, it is difficult to write coherent documentation that describes awkward operating procedures. 

E.H. Pechan Associates, Inc. "The Environmental Trends Analysis Model User Documentation. March 1984. 

Develop user documentation with information on how to install, test, and operate the program. 

The documentation supplied with the CDS application or system (both hardware and software), user notes, and user standard operating procedures will not be discussed here as it is too specific and also depends npon the management approach in an individual laboratory. However, the importance of this system-specific docnmentation for validation should not be underestimated. Keeping this docnmentation cnrrent shonld be considered a vital part of ensuring the operational validation of any compnterized system. The nsers should know where to find the current copies of documentation to enable them to do their job. The old versions of user SOPs, system, and user documentation shonld be archived. 

ANSI (1987), IEEE Standard for Software User Documentation, ANSI/IEEE Std. No. 1063-1987, The Institute of Electrical and Electronic Engineers, New York. 

While both supplier and validation documentation may provide the basis for user documentation, a comprehensive set of SOPs should be generated covering all features of database operation. These procedures would cover all aspects of system use and maintenance, from normal operation through to business continuity in the event of major system failure. 

The user documentation (e.g., user manual, on-line help). 

After the testing is complete and the code is corrected for errors, the software is released for production and distribution. The product is considered ready for release when it has met all the criteria specified in the quality plan and after formal sign-off by product line, quality assurance, and manufacturing management. A prerequisite for this is sufficient training of service engineers who must be able not only to install and operate the software but also to train users and answer users questions. Availability of user documentation in the... 

Change control Who initiates changes Who authorizes changes Are there procedures for change control Do they include impact analysis, test plans Is there a formal revision control procedure Will all updates get new version numbers Are there procedures for user documentation updates How are customers informed on changes ... 

User documentation Are there procedures and standards for the development and maintenance of user documentation What documentation is supplied For how long is the documentation supplied For how long is the user documentation archived ... 

Figure 5.1 was kindly provided by Dr. Gerhard Goldbeck-Wood from Accelrys, Inc. Equation 5.7 is proposed in the user documentation of the Phase Diagram software module of Accelrys, Inc. A slightly simpler version of this equation (without the d3-T term) was proposed, and its use was illustrated with several examples, by C. Qian, S. J. Mumby and B. E. Eichinger, Macromolecules, 24, 1655-1661 (1991). 

STRAUSBAUGH, J. andD. BLAISE (Eds.) 1991. The Drug User. Documents 1840—1960. Blast Books, New York. Foreword by William S. Burroughs. 

Dershowitz, W, Lee, G., Geier, J., Foxford, T., LaPointe, P. and Thomas, A. 1998. FracMan Interactive Discrete Feature Data Analysis. Geometric Modelling and Exploration Simulation, User Documentation, Golder Associates Inc., Seattle, Washington. 

Miller, 1., Lee, G. and Dershowitz, W. 1999. MAFIC Matrix/Fracture Interaction Code With Heat and Solute Transport User Documentation, Version 1.6, Golder Associates Inc., Redmond, Washington, November 30. 

H.K. Geyer et. al. GCtool for Fuel Cells System Design and Analysis User Documentation , Argonne National Laboratory, 1998, Report ANL-98/8. 

Supply adequately updated system and user documentation. 

The documentation of new developments includes process models, data models, programs (including programmer s comments, tools such as "where-used" lists and links between the models and objects) and user documentation. In addition, the entire test catalog contains the entire range of manual and automatic test cases and test procedures. 

G.3. Provision of user documentation (user manuals, administra-tion/technical manuals, update notice with each release)... 

Control of purchased items bought on behalf of customer (e.g., computer hardware, layered software products), including associated packaging, user documentation, warranties... 

Products with suboptimal user interfaces can be difficult and expensive to fix once they are in live operation. Not only do changes need to be carefully implemented but training materials and user documentation are also likely to need a refresh. It is far more efficient to get the user interface right from the start. Similarly manufacturers need to have an appreciation that poor interface design cannot be realistically be remedied by additional training. As discussed in Sect. 2.6 most slips and lapses simply cannot be addressed through the provision of advice or guidelines. 

User documentation Standard Operating Procedures Configuration specification Transition strategy Decision support rules... 

Specification and user documentation of the pre-developed software shall be available, defining explicitly all characteristics that are relevant in fulfilling the systems functional and performance specifications. lEC 60880-2 (Cat. A)... 

All certifying organization restrictions and operating procedures are provided in the user documentation. 

A complete lEC 61508 assessment includes a FMEDA, a study of Prior Use and adds an assessment of all fault avoidance and fault control measures during hardware and software development as well as detail study of the testing, modification, user documentation and manufacturing processes. The objective of all this effort is to provide a high level of assurance that an instrument has sufficient quality and integrity for a safety instrumented system application. This is clearly more important for products containing software as many end users have the strong opinion that software is "bad... 

Lastly column 9 is reserved for comments and relevant information. This area gives the reviewer an opportunity to suggest improvements in design, methods to increase strength of the component (against the perceived stress) or perhaps needed user documentation considerations. 

The insulation level is also specified. It is defined in kV, creepage distances, and air clearances in millimeters. Important additional specifications are related to maximum exposed surface temperature, protection against water penetration (drop/splash proof), cleaning-disinfection-sterilization procedures, technical and user documentation (Figure 10.35). 

Hindmarsh, A., Taylor, A. (1999). User documentation for IDA, a differential-algebraic equations solver for sequential and parallel computers. Lawrence livermoie National Laboratory, Center for Applied Scientific Computing. UCRL-MA-136910. 

NOTE This could be a stand-alone document, an instructional manual, a programming manual, a standard document, or included in the user document(s) defining application limitations. 

---