typey-type icon indicating copy to clipboard operation
typey-type copied to clipboard

Downloadable detailed data

Open didoesdigital opened this issue 3 years ago • 0 comments

Overview

People want to see more detailed data. Better data can improve feedback loops for more effective and efficient practice.

Problem

Local storage space is limited.

Approaches

One option is: "creating a plover plugin, that expects for session data to be manually loaded in after a typey-type session (download json, load into local plugin), that persists on the local machine over time and allows offline practice"

During a session, we could record detailed data in the app (not local storage) and offer a button somewhere (progress page?) to download the detailed progress data to use elsewhere. This gives users responsibility and ownership of their long-term progress data.

Considerations:

  • Keep it flexible so people can use it in whatever Plover plugins or programs they want to whatever end.
  • An accidental page refresh or closed tab will lose current session data. Maybe we could store latest/previous session in local storage and whenever Typey Type hits local storage limits, that's the first piece of local storage data to dump.
  • Version the data format so we can make changes over time, such as adding additional fields of interest (examples below)

Formats?

{
  "version": "0.0.1",
  "data": {
    "metWords": [
      {
         "wordOrPhrase": "list",
         "successfullyTypedCount": 12,
         "misstrokes": {
           " lift": 4,
           " Lys-​": 1,
           " HR*EUFT​": 3,
         }
      }
    ]
  }
}
{
  "version": "0.0.2",
  "data": {
    "metWords": [
      {
         "wordOrPhrase": "list",
         "successfullyTyped": [
           1526868810,
           1620520005,
           1620519996
         ],
         "misstrokes": {
           " lift": [1620520000, 1620519990],
           " Lys-​": [1526868800],
           " HR*EUFT​": [1526868610],
         }
      }
    ]
  }
}

didoesdigital avatar May 09 '21 00:05 didoesdigital