|
US$1829.00 · In stock
Delivery: <= 13 days. True-PDF full-copy in English will be manually translated and delivered via email.
GB/T 32424-2015: Systems and software engineering -- Requirements for designers and developers of user documentation
Status: Valid
| Standard ID | Contents [version] | USD | STEP2 | [PDF] delivered in | Standard Title (Description) | Status | PDF |
| GB/T 32424-2015 | English | 1829 |
Add to Cart
|
13 days [Need to translate]
|
Systems and software engineering -- Requirements for designers and developers of user documentation
| Valid |
GB/T 32424-2015
|
PDF similar to GB/T 32424-2015
Basic data | Standard ID | GB/T 32424-2015 (GB/T32424-2015) | | Description (Translated English) | Systems and software engineering -- Requirements for designers and developers of user documentation | | Sector / Industry | National Standard (Recommended) | | Classification of Chinese Standard | L77 | | Classification of International Standard | 35.080 | | Word Count Estimation | 87,855 | | Date of Issue | 2015-12-31 | | Date of Implementation | 2016-07-01 | | Regulation (derived from) | State Standard Announcement 2015 No.43 | | Issuing agency(ies) | General Administration of Quality Supervision, Inspection and Quarantine of the People's Republic of China, Standardization Administration of the People's Republic of China | GB/T 32424-2015: Systems and software engineering -- Requirements for designers and developers of user documentation
---This is a DRAFT version for illustration, not a final translation. Full copy of true-PDF in English version (including equations, symbols, images, flow-chart, tables, and figures etc.) will be manually/carefully translated upon your order.
Systems and software engineering - Requirements for designers and developers of user documentation
ICS 35.080
L77
National Standards of People's Republic of China
Systems and Software Engineering
Designers and developers of user documentation requirements
(ISO /IEC 26514.2008, MOD)
Issued on. 2015-12-31
2016-07-01 implementation
Administration of Quality Supervision, Inspection and Quarantine of People's Republic of China
Standardization Administration of China released
Table of Contents
Introduction Ⅲ
Introduction Ⅳ
1 Scope 1
2 Compliance 1
2.1 Overview 1
2.2 Compliance Application 2
2.3 Compliance Scene 2
3 Normative references 2
4 Terms and definitions 2
5 preparation process system/software life cycle of user documentation 7
6 project needs, objectives and constraints 9
6.1 Overview 9
6.2 Project Goal 9
6.3 user documentation requirements and constraints 10
Objectives and constraints of the project 11 6.4
6.5 users and usability goals 12
6.6 Interviews technical contact, and 13 other experts
6.7 Project Planning 13
6.8 Documentation Recommendation 16
7 Analysis and Design 17
7.1 Overview 17
7.2 audience and task analysis 17
7.3 User Document Design 21
8 Development and Review 22
8.1 Overview 22
8.2 prototype and draft document 22
8.3 Assessment Document 24
8.4 Test Document 27
28 9 Production
9.1 Overview 28
9.2 The final eds and review 28
9.3 approved 29
9.4 Configuration Management 29
9.5 update and maintain 29
10 Document 29
10.1 Overview 29
The overall structure of the document 30 10.2
10.3 depending on audience demand for document structure 31
Topic 10.4 screen size of 32 documents
Section 32 10.5 User Documentation
10.6 parts of the layout of the user documentation 33
User documentation content 11 34
11.1 Overview 34
11.2 completeness of the information 34
The accuracy of the information 34 11.3
Content identification data 34 11.4
11.5 Information document uses 35
35 11.6 Operating concept
11.7 software commonly used information 36
11.8 procedures and tutorial information 37
11.9 Information about the software instructions 38
Interpretation of data entry fields 39 11.10
Content 11.11 Error messages and solutions to problems 39
Content 11.12 Warnings and Precautions 40
11.13 The term information 40
11.14 Related Information Sources 41
41 user-provided content 11.15
Appendix A (informative) presented a document format 43
Annex B (informative) user documentation checklist 66
The terms and requirements Checklist Appendix C (informative) documentation process 71
Annex D (informative) terms and product requirements document checklist 74
References 78
Foreword
This standard was drafted in accordance with GB/T 1.1-2009 given rules.
This standard uses redrafted law revision using ISO /IEC 26514.2008 Designer "system and user documentation and software engineering open
Developer Requirements "(in English).
The Standard and ISO /IEC 26514.2008 technical differences are as follows.
--- The ISO /IEC 26514.2008 Chapter 12 moved to Appendix A, as an information appendix.
--- Remove the ISO /IEC 26514.2008 Annex A, Annex B and Annex C.
--- Remove the ISO /IEC 26514.2008 Appendix D.
--- Remove the ISO /IEC 26514.2008 requirements for English language habits of the content and format of the body part and the relevant examples.
Please note that some of the content of this document may involve patents. Release mechanism of the present document does not assume responsibility for the identification of these patents.
This standard by the National Information Technology Standardization Technical Committee (SAC/TC28) and focal points.
This standard was drafted. National Network Software Product Quality Supervision and Inspection Center (Jinan), China Electronics Standardization Institute, Guangzhou
Wide soft Information Systems Management Consulting Co., Ltd., Shanghai computer software technology development center.
The main drafters of this standard. Yangfu Tao, Huang Shanshan, Mengxian Yong, Zhang Bin, Zhang Xueli Yuan Su Rong, Liu, Cai Lizhi, Liu Zhenyu Hu Yun.
Introduction
Each user application software needs accurate information about how the software to help them complete the task. Documents may be a user to see
The first tangible items, so it will affect the user's first impression of the software product. If the document is to provide a convenient way of letter
Interest rates, and the information is easy to find and understand, then users will be able to quickly familiar with the software product. Thus, the document is not well-designed
Only help customers reduce the cost of training and support, and can enhance the reputation of products, manufacturers and suppliers.
Although software developers committed to user interface design is very intuitive, so that users no longer need a separate document, but it is not nearly
possible. Today's software offers more robust functionality, not only within the application, the application is also among the intelligent post information
change. Furthermore, most of the software design includes potential rules, calculation, or algorithm, when users use the software, it will affect their access
the result of. These potential programming techniques only through painstaking tests to be recognized user. For these reasons and more, the user
Documentation is still a major component of easy-to-use software products.
Documentation is often used as software to do after work. However, for high-quality software documentation, its development should be considered
An integral part of the software life cycle process. Want to do documentation or information management, the workload will be large enough to need its own process
plan.
Design and development documentation is part of the software life cycle process, this standard helps ISO /IEC 15288.2008 "Systems and Software Engineering
Cheng system life cycle process "or ISO /IEC 12207.2008" Systems and software engineering - Software life cycle processes, "the user design
And development documentation. It is a document from the developer's position defines the document process.
In addition to defining a standard process, this document also covers standard products. This standard specifies the structure, content and format of the document, but also for use
User documentation showing the format provides detailed guidance.
Early results tend to standard documentation procedure is considered a separate book or volume set, one-time delivery. Gradually,
Document designers realized most of user documentation controllable from previously developed information (single source document) multiplexing, after adaptation for soft
The new version of the member or for presenting on a variety of screen and print media. Although this standard does not describe how to build a content management system
(Contentmanagementsystem, referred to as CMS), but documentation is still organized to prepare for the single source document.
This standard applies to printed documents and screen documents, regardless of document generation software tools. Most of its guidance applies to system
User documentation, including hardware and software, user documentation, to ensure consistency of the document, completeness, accuracy and availability.
Systems and Software Engineering
Designers and developers of user documentation requirements
1 Scope
This standard specifies two aspects.
a) a standard procedure, the preparation and the process of user documentation;
b) Documentation Product Standards require the user document structure and content requirements.
The standard Chapter 5 - Chapter 9 defines the documentation process of user documentation designers and developers. Comprising. establishing user needs
Information, the information presented to the user to determine the way information is prepared and the information available. This process is not limited to the design and development life cycle
Stage, through activities including information management and documentation processes.
Chapter 10 and Chapter 11 provides information on the structure and content of the user requirements document. For Software system users in the work environment
Used in printed documents and screen documents, including printed user manuals, online help, tutorials, and user reference documentation.
Appendix A gives for English versions of the user documentation rendering format, Appendix B, Appendix C, Appendix D provides each user text
File checklist, the terms and documentation requirements checklist and procedure requirements of the terms and checklists product documentation.
Although this standard does not cover all aspects of the following types of documents, but for its development may be helpful.
a) In addition to the software product documentation;
b) the use of animation, video, audio, multimedia systems;
c) computer-based training (CBT) packages based curriculum materials and formal training programs for use;
d) for the installation personnel, computer operators or system administrators and other production rather than production for the end user documentation;
e) description of maintenance documentation system software internal operations;
f) incorporated into the document user interface.
This standard applies to the designers and developers of the document, including a variety of experts.
a) document information on product planning designers and architects in the centralized structure and format of the document;
b) determining the usability experts and business analysts expect the user to use the software to perform tasks;
c) staff development and editing of user documentation written content;
d) have a graphic designer electronic media expertise;
e) to design the document on the screen presented in the form of user interface designers and ergonomics experts.
This standard also for documentation in the process of other actors and stakeholders Now.
a) software development process or management documentation processes;
b) Read the demand side of the document prepared by the supply side;
c) usability testers, documentation experts and reviewers;
d) document creation screen developer tools;
e) determining the principles to make the document easier to understand and easy to use human factors expert.
2 Compliance
2.1 Overview
This standard can be used for the organization or project declaration of conformity ISO /IEC 15288.2008Systemsandsoftwareengineering-
Tips & Frequently Asked Questions:Question 1: How long will the true-PDF of GB/T 32424-2015_English be delivered?Answer: Upon your order, we will start to translate GB/T 32424-2015_English as soon as possible, and keep you informed of the progress. The lead time is typically 9 ~ 13 working days. The lengthier the document the longer the lead time. Question 2: Can I share the purchased PDF of GB/T 32424-2015_English with my colleagues?Answer: Yes. The purchased PDF of GB/T 32424-2015_English will be deemed to be sold to your employer/organization who actually pays for it, including your colleagues and your employer's intranet. Question 3: Does the price include tax/VAT?Answer: Yes. Our tax invoice, downloaded/delivered in 9 seconds, includes all tax/VAT and complies with 100+ countries' tax regulations (tax exempted in 100+ countries) -- See Avoidance of Double Taxation Agreements (DTAs): List of DTAs signed between Singapore and 100+ countriesQuestion 4: Do you accept my currency other than USD?Answer: Yes. If you need your currency to be printed on the invoice, please write an email to [email protected]. In 2 working-hours, we will create a special link for you to pay in any currencies. Otherwise, follow the normal steps: Add to Cart -- Checkout -- Select your currency to pay.
|