Approved terminology refers to specific words, phrases, or terms that have been selected for use in all documentation. Consistent use of these terms enhances understanding and ensures that content aligns with the brand’s voice and messaging.
Establishing Approved Terminology:
- Create a standard list: Develop and maintain a centralised list of approved terms for use across all documentation. This list should include terms frequently used within the context of WriteTech Hub’s products and services. Example: “dashboard,” “user interface,” “API,” “repository.”
- Define terms clearly: Provide clear definitions for each approved term. This helps writers and editors understand the correct context and usage, ensuring consistency. Example: “API (Application Programming Interface): A set of functions and procedures allowing the creation of applications that access the features or data of an operating system, application, or other service.”
Using Approved Terminology:
- Use terms consistently: Stick to the approved terms when writing documentation to avoid confusion. If “sign in” is the approved term, do not use “log in” or “log on” interchangeably.
- Update terminology regularly: Review and update the list of approved terms periodically to ensure it reflects current industry standards and internal changes. Remove outdated terms and add new ones as needed.
Dos:
- Use approved terms consistently: Example: “Use ‘sign in’ rather than ‘log in’ throughout the document.”
- Provide definitions for approved terms: Example: “Latency: The time delay experienced in a system due to data processing.”
Don’ts:
- Don’t use unapproved or conflicting terms: This can lead to confusion and reduce the professionalism of the documentation.