Support different audiences

[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: Multiple Participants noted the difficulty in finding documentation suited to their level of technical expertise or preference for high context instruction, suggesting the need for documentation to better distinguish between content for technical and non-technical users with high or low detail information needs.

User story 1
As a user, I want documentation that aligns with my technical expertise and detail preferences, so that I can quickly find the right level of information without sifting through content that is too basic or too complex.
User story 2
As a user, I want documentation that caters to different audiences, so that I can easily find content relevant to my role.

Acceptance Criteria

• Documentation is clearly structured into technical and non-technical sections.
• Users can choose between high-level overviews and detailed technical breakdowns.
• A landing page or filter option helps users navigate to content suited to their role and expertise.
• Technical documentation includes clear links to relevant documentation
• Technical documentation includes TLDR summaries of business context and vice-versa
• Summaries or TL;DR sections are included for quick understanding, with expandable deep-dive sections for advanced users.
• FAQs or "Explain Like I'm 5" (ELI5) summaries accompany complex topics.
• Pages follow a clear, predictable structure, making it easier for users to scan and locate relevant details.
• Related content is grouped together, ensuring that users can follow logical learning paths.
• Tentative:
  • A simple feedback mechanism (e.g., “Was this page helpful?”) gathers insights on clarity and usefulness.
  • Each page includes labels or icons indicating content type (e.g., "Business Overview," "Developer Guide," "Step-by-Step Tutorial").
  • Each user role has a tailored onboarding flow, guiding them to the most relevant introductory material and next steps in the implementation journey.
  • Documentation is organised into distinct sections based on user roles (e.g., Business Users, Technical Implementers, Regulators).

Impacted sections

UNTP Spec:
Website - https://uncefact.github.io/spec-untp/
https://jargon.sh/user/unece/untp-core/v/0.5.0/artefacts/readme/render
Reference Implementation/Testing:
Website - https://uncefact.github.io/tests-untp/

Related tickets

Create a resource hub #281