Part 1: Define the problem

What problem are you trying to solve?

SDK documentation is missing examples with real values (not just descriptions) and lacks good navigability. As the number of packages inside the monorepo grow, there might be some difficulties to find what each of them does and how they work together.

What is your hypothesis?

Having a better documentation:

Reduces time on support tasks
Increases confidence of external devs to build on their own

What value does this bring to our customer and/or our mission? What is the goal?

Customers & mission:

Increases the autonomy of external devs when using the SDKs
Facilitates its use by giving real examples and explains basic and edge cases

Goals:

See an increase in the number of external developers using the SDKs
While reducing the number of questions in our support channels or the time spent on support (as we can’t control what it is asked)

How do we measure it?

Our responses to the questions in our support channels are shorter and contain more links to our documentation.
Npm weekly downloads
Github forks?

Links:

// Include useful research, such as user tests, competitive analysis, metrics, or surveys.

Part 2: Shaping the problem

// Once the problem statement has passed the Great Filter, work with the team on the problem statement and elaborate on the following points to create more certainty around the problem and possible solutions.

Non Goal(s)

// Controlling the scope

Possible Solution(s)

Rough Scoping & Timeline

// At a high level, what's included in V1 vs. later versions? How big of a project is this? What's the roll out / testing plan? What networks to be used? Consider the major pieces of functionality, Mobile, Platform, Entry Points, User Onboarding.

Risk(s), Key Trade Offs & Decisions

// For example, were there any alternatives considered? What are the value, usability, feasability and business risks and how could we address them?

safe-global / safe-pm

Core SDK documentation is missing examples with real values (not just descriptions) and lacks good navigability #43