Clarify Technical Terminology In-Context

[DenicaGo]

Description

Context: The onboarding process for new implementers has proven to be challenging so user research was done with early implementers to address any obstacles by identifying and analysing areas for improvement within the onboarding experience.

Research finding: A number of participants struggled with the use of technical or domain specific jargon throughout the documentation. Clear definitions or links to glossaries would make the content more accessible and improve comprehension.

User story: As a user, I want technical terms to be clearly defined in-context within the documentation or through tooltips, so that I can fully understand the content without needing external explanations.

Acceptance Criteria

• All technical or domain-specific terms are clearly defined within the documentation where they first appear.
• Definitions should be concise, non-technical, and provide practical context.
• Each technical term should be linked to a central glossary that provides a more detailed explanation if needed.
• The glossary should be easily accessible from the main navigation and searchable.
• Defined terms should be visually distinct (e.g., underlined, bolded, or marked with an info icon) for easy identification.
• A standardised approach should be used across all documentation pages.
• Definitions and tooltips should be easy to update when terminology evolves.
• A process should be in place to identify and address unclear terms based on user feedback.

Tooltip Support (If Feasible):

• Hovering over a technical term displays a short, inline definition in a tooltip.
• Tooltips should not disrupt reading and must follow accessibility best practices (keyboard and screen reader compatible).