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

Clarify Service Differentiation and Integration #288

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

Clarify Service Differentiation and Integration #288

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: Multiple participants reported confusion about the purpose of individual services and their roles within the larger system. It also wasn’t clear which were mandatory to the protocol vs not. This indicates a need for clearer communication and documentation around services.

User story: As a user, I want clear explanations of what each service does and how the services fit together, so that I can easily determine which services are relevant to my needs and how to use them effectively.

Acceptance Criteria

  • Each service has a clear, concise description of its purpose and functionality.
  • Documentation clearly outlines how each service interacts with others in the system.
  • It is explicitly stated which services are mandatory and which are optional for implementation.
  • There are visual diagrams or flowcharts that illustrate how services connect and work together.
  • Services are categorized based on their relevance to different user needs, such as business or technical.
  • A use case or example is provided for each service, showing how it can be applied in real-world scenarios.
  • Links to related services and documentation are included to help users understand how services complement each other.
  • Clear guidance is provided on how to choose the right services for different implementation scenarios.

Impacted sections

UNTP Spec:
GitHub repo - https://github.com/uncefact/spec-untp
Website - https://uncefact.github.io/spec-untp/
Reference Implementation/Testing:
GitHub repo - https://github.com/uncefact/tests-untp
Website - https://uncefact.github.io/tests-untp/

Related Tickets

Improve initial setup documentation #283

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