What is BS EN ISO 13920-B: 2012 ?

Title: What is BS EN ISO 13920-B: 2012? A Comprehensive Guide

Software documentation is a crucial aspect of software development, as it helps developers, users, and other stakeholders understand the software's functionality, features, and benefits. The documentation should be clear, concise, and well-organized to facilitate effective communication among different teams and stakeholders. In this article, we will explore the key aspects of BS EN ISO 13920-B: 2012, which is a technical standard designed to enhance the clarity and consistency of software documentation.

Main Elements of BS EN ISO 13920-B: 2012:

Structure and Format

BS EN ISO 13920-B: 2012 provides guidelines on the structure and format of software documentation. It recommends using a consistent and clear format for all types of documentation, including user manuals, technical reports, and installation guides. The standard emphasizes the importance of a modular and hierarchical structure, which allows users to easily navigate and locate the information they need.

Content and Language

BS EN ISO 13920-B: 2012 emphasizes the importance of clear and concise language in software documentation. It recommends using simple and straightforward language to explain technical concepts and commands. The standard also recommends using a consistent vocabulary and terminology across different types of documentation.

Illustrations and Diagrams

BS EN ISO 13920-B: 2012 recognizes the importance of illustrations and diagrams in software documentation. It recommends using high-quality illustrations and diagrams to help users understand complex technical concepts and procedures. The standard also recommends using a consistent style and format for illustrations and diagrams.

Tables and Charts

BS EN ISO 13920-B: 2012 also recognizes the importance of tables and charts in software documentation. It recommends using tables and charts to present information in a clear and concise manner. The standard provides guidelines on the formatting, content, and placement of tables and charts.

References

BS EN ISO 13920-B: 2012 emphasizes the importance of proper references in software documentation. It recommends using a consistent citation style for references, including text and graphics. The standard also recommends using a clear and concise reference list to provide users with the information they need.

Layout and Presentation

BS EN ISO 13920-B: 2012 provides guidelines on the layout and presentation of software documentation. It recommends using a consistent and clear layout for all types of documentation. The standard also recommends using appropriate fonts, colors, and other design elements to make the documentation more visually appealing.

Conclusion:

BS EN ISO 13920-B: 2012 is a technical standard designed to enhance the clarity and consistency of software documentation. By adhering to the guidelines provided in this standard, software developers, maintainers, and users can create more effective and efficient documentation that promotes understanding and collaboration among different teams and stakeholders.