ecadlabs / taquito

A library for building dApps on the Tezos Blockchain - JavaScript / TypeScript
https://taquito.io
Apache License 2.0
298 stars 118 forks source link

SPIKE: User feedback on the website #1361

Open Innkst opened 2 years ago

Innkst commented 2 years ago

Problem

We have defined Taquito Success Metrics. But we are missing a bit piece of feedback based on documentation as well as need a better way to do surveys.

In particular, we want to look at how to gather metrics for the following:

  1. (Leading) Surveys on specific features, sign up to get notification when a particular bigger feature is available, etc.
  2. (Lagging) NPS (https://en.wikipedia.org/wiki/Net_Promoter)
  3. (Lagging) How helpful Taquito documentation is by chapter, including TypeDoc

Acceptance criteria for this research:

We want to research which UI frameworks can:

  1. Support the following features:
    1. Ability to run 1-2 question survey, up to 2 levels deep. Examples below.
    2. Display normal text with/without links, i.e. to provide a link to the survey from the website.
    3. Display text with Thumb up and down:
      1. Example: Was this page helpful? πŸ‘ πŸ‘Ž
      2. Can follow up with the text field and question of user answered πŸ‘Ž
    4. Allow for questions with Yes/No buttons, comment answers, rate from 0 to 10, single, and multi-selects.
    5. Save results of the survey and πŸ‘ πŸ‘Ž feedback for further analysis
    6. Ability to create a report(csv, xlsx) or dashboards (pie charts, histograms, etc.)
  2. Easily integrate with Docusaurus, Gatsby. Ideally, it is the same framework for both.

Some examples:

  1. https://code.visualstudio.com/docs
  2. https://docs.microsoft.com/en-us/dotnet/core/introduction

Look at what is available from Google. They have Google Survey. It should integrate well with their BigQuery interface.

jevonearth commented 2 years ago

An example of this feature can be seen at https://relay.dev/docs/. The implementation of this feature can be seen at https://github.com/facebook/relay/blob/main/website/src/core/DocsRating/index.js.