標準號：BS 7830-1996
中文標準名稱：應用軟件用戶用屏幕上文件管理的設計和制作指南
英文標準名稱：Guide to the design and preparation of on-screen documentation for users of application software
標準類型：A14
發布日期：1996/5/15 12:00:00
實施日期：1996/5/15 12:00:00
中國標準分類號：A14
國際標準分類號：01.110;35.080
適用范圍：1 General This British Standard gives recommendations for and guidance on the development of on-screen user documentation for application software. Such documentation supplements the software's user interface. This British Standard covers the process of developing the documentation and gives guidelines for the content, navigation, style and presentation of the information. 2 On-screen documentation On-screen documentation in the context of this British Standard includes any information users can access on a screen about the software they are using. It includes, for example: - context-sensitive displays of names of user interface objects (such as bubble help or balloon help); - help status lines that explain what the current context is, or what the selected object can do; - context-sensitive displays of instructions and descriptions; - sets of related topics that users can browse through; - free-standing documentation systems. The guidance in this British Standard may be helpful for developing the following types of documentation, although it does not cover all aspects of them: - free-standing documentation systems where there is no related application software; - multi-media systems using, for example, video and sound; - on-screen tutorials and computer-based training (CBT) packages. On-screen documentation is fundamentally different from paper documentation in that it is not suitable for reading sequentially, page by page, In most cases, on-screen documentation consists of a series of self-contained texts that are relevant to specific situations within the application. The task of creating on-screen documentation is to identify these situations and to create brief, relevant, accurate texts. 3 Application software Application software is software designed to help users perform particular tasks or handle particular types of problem, as distinct from software that controls the computer itself. For the purposes of this British Standard, application software includes the types listed below: - consumer software packages, that is, software products designed and sold to carry out identified tasks, where the software and its associated documentation are packaged for sale as a unit; - software for office applications such as word processors, spreadsheets, databases and electronic mail; - business software, for example, software for recording and monitoring business activities such as stock control and order processing; - specialist software for use by professionals, such as accounting systems, graphic design systems and engineering design systems. The guidance may also be helpful for developing on-screen documentation for the following, although it does not cover all the issues relating to them: - software engineering products for use by computer professionals; - software for programmable electronic or mechanical systems; - medical systems and manufacturing systems that require special safety-related documentation. 4 Overview There is an overview of the contents of this British Standard, explaining its structure, in section 2. Annex D explains how different types of reader can use this standard; it gives simple route-maps for the different types of reader to follow. 5 Process Process recommendations are in sections 3 to 7. They cover the separate phases of developing on-screen documentation. Annex A gives checklists for recording and monitoring progress through the development phases. Annex B gives checklists that can be used as the basis for documentation reviews. Annex C covers evaluation of on-screen documentation systems. 6 Guidelines for on-screen documentation Guidelines on the contents, navigation, style and presentation of on-screen documentation are in sections 8 to 11. Readers should refer to these guidelines sections during each phase of the process. 7 Reference information Annex E contains lists of books that might be useful to readers.