By adopting a controlled language such as Simplified Technical English, we can improve clarity, reduce ambiguity, improve translation, and reduce costs.
STE uses a limited vocabulary and a specific set of grammar rules to make technical information more concise and easier to understand. By using simple and clear language, technical writers can communicate complex information more effectively to a broader audience, including non-native speakers and people with limited technical backgrounds.
Technical documentation written in STE has fewer ambiguities and inconsistencies because it follows a standardized set of writing rules. This makes it easier for readers to understand technical information and reduces the risk of misunderstandings or errors.
By using clear and concise language, technical writers can reduce the complexity of their documentation and make it easier to translate accurately into other languages.
Using STE can help reduce the cost of technical documentation by simplifying the writing process and reducing the time required for editing and proofreading. Additionally, because STE is designed to be easily translatable, it can help reduce the cost of translation and localization.
Implementation
Choose a subset of rules and guidelines.
Training and awareness
Install and configure tools that can assist writing, for example, VS Code extensions.
Rewrite content, either as an all-in-one migration or as part of the definition of done as we tackle issues (if you update the page, you also apply the STE guidelines).
digitaldiina
commented
1 year ago
By adopting a controlled language such as Simplified Technical English, we can improve clarity, reduce ambiguity, improve translation, and reduce costs.
STE uses a limited vocabulary and a specific set of grammar rules to make technical information more concise and easier to understand. By using simple and clear language, technical writers can communicate complex information more effectively to a broader audience, including non-native speakers and people with limited technical backgrounds.
Technical documentation written in STE has fewer ambiguities and inconsistencies because it follows a standardized set of writing rules. This makes it easier for readers to understand technical information and reduces the risk of misunderstandings or errors.
By using clear and concise language, technical writers can reduce the complexity of their documentation and make it easier to translate accurately into other languages.
Using STE can help reduce the cost of technical documentation by simplifying the writing process and reducing the time required for editing and proofreading. Additionally, because STE is designed to be easily translatable, it can help reduce the cost of translation and localization.
Implementation