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 Initial Setup Documentation #283

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

Improve Initial Setup Documentation #283

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: Several participants mentioned the onboarding process as potentially more burdensome than it needs to be. Documentation can be streamlined by breaking down large sections into digestible chunks, creating a more intuitive flow, especially for first-time users and grouping related topics together to ensure that all necessary introductory material is upfront.

User story: As a new user, I want to follow a clear, concise, and easy-to-understand initial setup guide, so that I can get started quickly without feeling overwhelmed or encountering setup errors.

Acceptance Criteria

  • The onboarding guide is structured in small, digestible steps to prevent information overload.
  • Each step includes clear instructions, examples, and expected outcomes to reduce ambiguity.
  • The most critical setup tasks are presented upfront in a logical, step-by-step sequence.
  • Related topics are grouped together to ensure necessary context is provided at the right time.
  • Common pitfalls and troubleshooting tips are provided at relevant points in the guide.
  • Technical jargon is minimized, and any required terms are defined in context or linked to a glossary.
  • The guide is visually structured with headings, bullet points, and callouts to improve readability.
  • A quick-start summary or checklist is available for experienced users who want to skip unnecessary details.

Impacted sections

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###

Ticket replicated here: uncefact/tests-untp#209

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