ISO-TR 22372:2017 is a technical report published by the International Organization for Standardization (ISO). It provides guidelines and recommendations for writing thorough and comprehensive technical articles. This article aims to explain the key points covered in ISO-TR 22372:2017 and highlight its significance in the field of technical writing.
Scope and Purpose
The scope of ISO-TR 22372:2017 encompasses various aspects of technical writing, including content organization, clarity, referencing, and citation methods. It aims to assist writers in producing high-quality technical articles that are easy to understand, well-structured, and informative.
The purpose of ISO-TR 22372:2017 is to enhance the overall quality of technical articles, promote effective communication, and ensure consistency among different publications. By following the guidelines outlined in this report, technical authors can improve their writing skills and produce articles that meet international standards.
Key Guidelines and Recommendations
ISO-TR 22372:2017 provides several key guidelines and recommendations to help authors write thorough technical articles:
Content Organization: The report emphasizes the importance of clear and logical organization of content. Authors should use appropriate headings, subheadings, and bullet points to present information in a structured and easily navigable manner.
Clarity and Simplicity: The document stresses the need for clarity and simplicity. Authors should use plain language, avoid jargon, and define technical terms when necessary. Diagrams, graphs, and illustrations can also be helpful in conveying complex information.
Referencing and Citation: Proper referencing and citation practices are crucial. ISO-TR 22372:2017 provides guidelines on citing sources, using references, and avoiding plagiarism. It highlights the importance of accuracy, validity, and reliability of referenced materials.
Language and Grammar: The document encourages authors to pay attention to language usage and grammar. It provides tips for improving readability, sentence structure, and punctuation. Additionally, it emphasizes the importance of proofreading and editing to eliminate errors and improve overall quality.
Visual and Technical Elements: ISO-TR 22372:2017 addresses the effective use of visual elements such as tables, figures, and equations. It provides suggestions on formatting, numbering, and labeling these elements to enhance clarity and facilitate understanding.
Conclusion
ISO-TR 22372:2017 serves as a valuable resource for technical authors, providing them with essential guidelines for writing thorough and comprehensive articles. By following the recommendations outlined in this report, authors can produce high-quality technical content that is well-structured, easy to understand, and aligned with international standards.
By adhering to the principles and guidelines presented in ISO-TR 22372:2017, technical writers can enhance their skills, improve the quality of their work, and contribute to effective knowledge dissemination within their respective fields.
Nina She