What is BS EN ISO 18323:2013 ?

What is BS EN ISO 18323:2013?

BS EN ISO 18323:2013 is a technical standard that outlines the requirements for writing clear and concise software documentation. It pertains to the documentation of computer programs and software systems and provides guidelines on various aspects of documentation, including structure, content, style, and presentation.

The purpose of BS EN ISO 18323:2013 is to enhance the clarity and consistency of software documentation, enabling developers, maintainers, and users to comprehend and utilize the software effectively. It aims to provide practical guidance on how to effectively communicate technical information in a way that is clear, concise, and easily understandable.

Key Elements of BS EN ISO 18323:2013

BS EN ISO 18323:2013 provides guidelines on various aspects of software documentation, including structure, content, style, and presentation. The standard outlines the following key elements:

1. Structure: The standard provides guidelines on the overall structure of software documentation, including the use of sub-sections,, and sections.

2. Content: The standard outlines the type of information that should be included in software documentation and provides guidance on the formatting and presentation of that information.

3. Style: The standard provides guidance on the use of fonts, colors, and other visual elements to enhance the readability and overall presentation of software documentation.

4. Presentation: The standard outlines the guidelines for presenting information in a clear and concise manner, including the use of tables, diagrams, and other visual aids.

The purpose of EN ISO 21332:2012 is to provide practical guidance on how to effectively communicate technical information in a way that is clear, concise, and easily understandable. It aims to ensure that technical documents are well-structured, accessible, and free from ambiguity.

Key Requirements of EN ISO 21332:2012

To ensure that technical documents are well-structured, accessible, and free from ambiguity, EN ISO 21332:2012 provides the following key requirements:

1. Clarity: Technical documents should be written in a clear and concise manner, using appropriate language and formatting.

2. Accuracy: Technical documents should accurately reflect the intended functionality and features of the software.

3. Consistency: Technical documents should be consistent in format, structure, and content across different software components.

4. Readability: Technical documents should be written in a font and color scheme that is easily readable by the intended audience.

5. Contextual information: Technical documents should include appropriate contextual information, such as system requirements, design specifications, and troubleshooting tips.

In conclusion, BS EN ISO 18323:2013 is an essential standard for software documentation that provides guidelines on various aspects of documentation, including structure, content, style, and presentation. By following this standard, organizations can improve the quality and consistency of their technical writing, facilitating better comprehension among readers.