ISO/TR 30403:2013 is a standard that provides guidelines for professional technical writing, with a focus on ensuring that technical documentation meets the needs of the intended audience and enables them to understand and use the product or service effectively. The main objective of this standard is to ensure that technical documentation is clear, concise, and user-friendly, while also addressing aspects such as document structure, language usage, and visual aids.
ISO/TR 30403:2013 is based on the following key guidelines and recommendations:
* Clarity: Technical documentation should be written in a clear and concise manner, using terms and language that are appropriate for the intended audience.
* Conciseness: Technical documentation should be written to minimize the number of words and phrases, while still providing enough information to enable the reader to understand the topic.
* Usability: Technical documentation should be written to be easy to read and use, with a clear and logical structure, and appropriate use of headings, subheadings, and other formatting tools.
* Document structure: Technical documentation should be structured in a logical and intuitive manner, with clear and consistent naming conventions, and appropriate use of headings and subheadings.
* Language usage: Technical documentation should use professional and appropriate language, avoiding the use of jargon or overly technical terms that may be difficult for non-technical readers to understand.
* Visual aids: Technical documentation should use appropriate and clear visual aids to help illustrate key concepts and ideas, while also avoiding the use of unnecessary or excessive use of visual elements.
By following these guidelines and recommendations, technical writers can produce high-quality, effective, and user-friendly technical documentation that meets the needs of the intended audience and helps them to understand and use the product or service effectively. This, in turn, can contribute to the success of the organization and ensure that the product or service is successful in achieving its intended goals.
Contact: Eason Wang
Phone: +86-13751010017
E-mail: sales@china-item.com
Add: 1F Junfeng Building, Gongle, Xixiang, Baoan District, Shenzhen, Guangdong, China