First Successful SDK Request
Design an SDK onboarding path that gets a developer from project setup to a verified request with useful recovery guidance.
The brief
Understand the problem
Background
Getting-started guides often mix languages, environments, authentication, and production concerns in one long page. Developers need a runnable path for their chosen stack and clear explanations when local setup differs.
User context
Fatima is adding a messaging SDK to a TypeScript service. She has a test project but needs to know where credentials belong and how to verify the first response safely.
Product problem
Onboarding should minimize context switching while preventing copied secrets, obsolete commands, and a false sense that a test request is production readiness.
Objective
Create environment selection, installation, credential setup, first request, and response verification for one SDK.
What to design
Define the experience
Required experience
- Choose language, framework, package manager, and environment
- Install a pinned supported SDK version
- Configure a test credential securely
- Run and inspect the first successful request
Screens and states
- SDK quickstart setup
- Installation step
- First request workspace
- Response and next steps
Core user flow
Follow the critical path
- 01
Fatima selects TypeScript, Bun, and test mode
- 02
The guide produces a pinned install command and environment-variable setup
- 03
She runs a minimal send request with her own recipient
- 04
The response explains the request identifier and links to production-readiness checks
Product rules
Requirements and constraints
Requirements
- Keep every code sample consistent with selected stack and version
- Separate copyable code from values the developer must supply
- Show expected success and common error responses
- Preserve a short completed-step history and links to deeper references
Constraints
- Secret values cannot be embedded in generated sample code
- Commands must identify operating-system differences
- A quickstart cannot imply production security or scale readiness
Reality check
States worth considering
Finish line
What to deliver
- Four desktop screens with a successful request and one recoverable error
Optional direction
Visual resources
Use these as a starting constraint if you want one. They are not part of the required solution.
Theory to review
UX principles for this brief
Use these as decision lenses, then validate the design with the people and context in the brief.
phenomenonParadox of the Active UserPeople often begin productive action immediately instead of investing first in broad instruction that might improve later efficiency.
effectGeneration EffectInformation people generate themselves is often remembered better than comparable information they only read.