EN ISO 8666: 2012 is a technical standard that outlines guidelines for the documentation of computer programs. It is designed to assist software developers in expressing program designs, code, and other related information clearly and consistently. The standard is divided into several parts, each covering a specific aspect of program documentation.
One of the key aspects of EN ISO 8666: 2012 is its focus on ensuring the quality and accuracy of professional writing, particularly in the field of technical documentation and manuals. It provides guidelines for legibility, permanence, and durability of written information, as well as factors such as ink, paper, printing methods, and environmental conditions that can affect the longevity of the document.
EN ISO 8666: 2012 addresses various variables that can affect the quality of program documentation, including the use of programming languages, the level of detail to be included in the documentation, and the target audience for the software. It also encourages writers to consider the overall user experience when developing technical documentation, including the use of clear and concise language and appropriate formatting.
Recommendations and Best Practices
EN ISO 8666: 2012 provides several recommendations and best practices for software developers and documentation writers. These include:
* Use a consistent and standardized format for documenting programming information, including naming conventions, formatting, and language.
* Provide enough detail in the documentation to enable the reader to understand the program's purpose, functionality, and potential issues.
* Use appropriate ink, paper, and printing methods to ensure the longevity of the document.
* Consider the target audience and user experience when developing the documentation, including the use of clear and concise language and appropriate formatting.
* Use a consistent and clear nomenclature to avoid confusion and ensure readability.
* Use appropriate testing and review processes to ensure the quality and accuracy of the documentation.
Conclusion
EN ISO 8666: 2012 is an important standard for software developers and documentation writers to consider when developing technical documentation. By following the guidelines and recommendations outlined in the standard, writers can enhance their skills and produce more effective and reliable technical articles. Additionally, using a standardized approach like EN ISO 8666: 2012 can help improve program readability and understandability, making it easier for developers to collaborate and maintain software systems.
Contact: Eason Wang
Phone: +86-755-13751010017
E-mail: info@iec-equipment.com
Add: 1F Junfeng Building, Gongle, Xixiang, Baoan District, Shenzhen, Guangdong, China