What is BS EN ISO 14122-3:2013 ?

Title: What is BS EN ISO 15502-3:2013 and EN ISO 20361:2014?

Technical writing plays a vital role in the software industry. It is the primary medium through which developers, users, and other stakeholders communicate complex concepts and ideas. To ensure that technical articles are written in a consistent and standardized manner, various technical standards have been developed. In this article, we will discuss the purpose and significance of two such standards: EN ISO 15502-3:2013 and BS EN ISO 20361:2014.

Purpose of EN ISO 15502-3:2013:

EN ISO 15502-3:2013 is a standard that provides guidelines and requirements for writing professional and accurate technical articles. The primary objective of this standard is to ensure that technical articles are written in a consistent and standardized manner. By adhering to the guidelines outlined in EN ISO 15502-3:2013, technical writers can effectively communicate complex concepts without ambiguity or misunderstanding.

Key Components of EN ISO 15502-3:2013:

EN ISO 15502-3:2013 is composed of several key components, which are essential for ensuring the quality of technical writing. These components include:

Subject matter expertise: This refers to the area of technical knowledge and expertise that the author of the article possesses. It is crucial for the author to have a deep understanding of the subject matter to produce accurate and relevant information.

Writing style: This refers to the tone, language, and formatting of the article. EN ISO 15502-3:2013 provides guidelines on the use of technical jargon, as well as the appropriate formatting of technical articles.

Clarity and consistency: EN ISO 15502-3:2013 emphasizes the importance of ensuring that the information presented is clear and consistent. This requires the author to use a consistent language and formatting throughout the article.

Accuracy and completeness: EN ISO 15502-3:2013 requires technical writers to ensure that the information presented is accurate and complete. This means that the author must conduct thorough research and provide accurate data to avoid errors and misunderstandings.

Purpose of BS EN ISO 20361:2014:

BS EN ISO 20361:2014 is a technical standard that pertains to the documentation of computer programs and software systems. It outlines the requirements for writing clear and concise software documentation, which is critical in facilitating proper understanding and effective communication among developers, users, and other stakeholders. By adhering to the guidelines outlined in BS EN ISO 20361:2014, software developers can produce high-quality documentation that is easy to understand and use.

Key Elements of BS EN ISO 20361:2014:

BS EN ISO 20361:2014 is composed of several key elements, which are essential for ensuring the quality of software documentation. These elements include:

Documentation structure: This refers to the organization and arrangement of the documentation. BS EN ISO 20361:2014 provides guidelines on the structure of documentation, including the use of consistent and logical hierarchies, as well as the use of appropriate formatting and naming conventions.

Documentation content: This refers to the information that is documented in the software. BS EN ISO 20361:2014 provides guidelines on the content of documentation, including the use of clear and concise language, as well as the avoidance of unnecessary details and duplications.

Documentation format: This refers to the style and formatting of the documentation. BS EN ISO 20361:2014 provides guidelines on the use of various documenting formats, including the use of standard templates and the use of multimedia elements.

Documentation presentation: This refers to the manner in which the documentation is presented to users. BS EN ISO 20361:2014 provides guidelines on the presentation of documentation, including the use of clear and concise language, as well as the avoidance of misleading or confusing elements.

Conclusion:

EN ISO 15502-3:2013 and BS EN ISO 20361:2014 are two crucial standards that must be adhered to for effective technical writing. By providing guidelines and requirements for writing professional and accurate technical articles, these standards help ensure that technical writers can effectively communicate complex concepts without ambiguity or misunderstanding. By understanding the purpose and components of these standards, software developers can produce high-quality documentation that is easy to understand and use.