Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Navigation Between Services and Documentation #285

Open
DenicaGo opened this issue Feb 4, 2025 · 0 comments
Open

Improve Navigation Between Services and Documentation #285

DenicaGo opened this issue Feb 4, 2025 · 0 comments

Comments

@DenicaGo
Copy link

DenicaGo commented Feb 4, 2025

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: We saw there was some difficulty for participants navigating between services and documentation. They relied on external bookmarks or for some they didn’t know the other tools and documents existed. Improving the navigation between services and different sections of the documentation can create a more cohesive flow and reduce friction.

User story: As a user, I want to navigate easily between related sections of the documentation and services, so I can find the information I need without unnecessary effort.

Acceptance Criteria

  • All documentation and tool interfaces include clear, consistent navigation to related resources across different sites.
  • Each page provides direct links to relevant tools, documentation sections, and services to prevent dead ends.
  • A centralized navigation menu or hub allows users to see and access all available tools and documentation in one place.
  • Cross-site navigation is seamless, with persistent headers, footers, or contextual links guiding users between resources.
  • Each tool or service includes a clear links directing users to the appropriate supporting materials or referenced tools.

If feasible:

  • A search function spans multiple sites, enabling users to find relevant content across documentation and tools without needing to search separately.

Impacted sections

UNTP Spec:
GitHub repo - https://github.com/uncefact/spec-untp
Website - https://uncefact.github.io/spec-untp/
https://jargon.sh/user/unece/untp-core/v/0.5.0/artefacts/readme/render
Reference Implementation/Testing:
GitHub repo - https://github.com/uncefact/tests-untp
Website - https://uncefact.github.io/tests-untp/
Demo Instance - https://untp.showthething.com/
Playground - https://test.uncefact.org/untp-playground

Related tickets:

Create a resource hub #281

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant