Consistency is key to creating a cohesive and professional user experience. Inconsistent terminology, formatting, or structure can confuse users and undermine the credibility of our documentation.
- Terminology
Use consistent terminology throughout all documentation. If a specific term is used to describe a feature or function, ensure that the same term is used every time. Maintain a glossary of approved terms to aid consistency across documents. - Formatting and Structure
Adhere to the formatting and structural guidelines provided in this style guide. Consistent use of headers, lists, code blocks, and other formatting elements helps users navigate the documentation more easily. - Documentation Templates
Utilise standard templates for similar types of documentation, such as user guides, API references, and tutorials. Templates help ensure that all documents follow a consistent format and structure, making it easier for users to find the necessary information. - Cross-Referencing
When referencing other sections of the documentation, be consistent in how you refer to them. For example, if you refer to another section as “Chapter 2,” ensure it’s consistently labelled as such in every instance.