What is BS EN ISO 20471:2013 ?

What is BS EN ISO 20471:2013?

BS EN ISO 20471:2013 is a technical standard that outlines the requirements for software documentation. It is designed to enhance the clarity and consistency of software documentation, enabling developers, maintainers, and users to comprehend and utilize the software effectively.

The standard provides guidelines on various aspects of documentation, including structure, content, style, and presentation. It is important for software companies to comply with this standard to ensure that their software products are clearly and concisely documented, which is crucial for successful implementation and adoption.

BS EN ISO 20471:2013 is an international standard that was developed by the International Organization for Standardization (ISO). It is widely recognized and adopted by companies around the world as the benchmark for software documentation quality.

Key Elements of BS EN ISO 20471:2013

BS EN ISO 20471:2013 has several key elements that software companies should understand and implement to ensure compliance with the standard. These elements include:

Clear and concise language: The standard calls for the use of clear and concise language in software documentation. The language should be easy to understand and should avoid the use of technical jargon or overly complex explanations.

Objective and informative structure: The standard emphasizes the importance of a well-structured and informative structure in software documentation. The documentation should be organized into logical sections and subsections, and each section should be titled accurately.

Content relevance and currency: The standard requires software documentation to be relevant and up-to-date. Companies should regularly review and update their documentation to ensure that it reflects the current state of their software products.

Consistency in format and style: The standard specifies the format and style of software documentation. Companies should ensure that they use a consistent format and style throughout their documentation to avoid confusion and maintain the integrity of their software products.

Appropriate use of images and diagrams: The standard allows for the use of images and diagrams in software documentation to help developers better understand the software. Companies should use these graphics and images appropriately, avoiding overuse or inappropriate usage.

Conclusion

BS EN ISO 20471:2013 is an essential standard for software companies to comply with if they want to ensure that their software products are clearly and effectively documented. By implementing the guidelines outlined in this standard, software companies can create software documentation that is more user-friendly, easier to understand, and more effective in facilitating communication and success.