search

akeshavan / mindlogger-app-admin-v2

0 stars 1 forks source link

Update Terminology #1

Open akeshavan opened 5 years ago

akeshavan commented 5 years ago

Rename terminology of the app:

Activity Set --> Folder Activity --> Survey Screens --> Questions

From user testing, we found the terminology to be too confusing. Lets not introduce new terms when existing ones work

akeshavan commented 5 years ago

To fix this issue, you should be able to do a find/replace in the code.

binarybottle commented 5 years ago

"Survey" and "Questions" are too narrow. Let's try again.

From a user's perspective, the only terms they need to know relate to what they're doing ("activity") and where it came from ("activity set"). The term "activity set" is too easily confused with "activity", so we should replace it. The term "activity" or "task" works pretty well, because a user is "notified to do an activity". When a user visits the public/personal library, they see an icon for the "HBN Speech [X]" and when they see their list of activities, there is an icon indicating that that activity is part of [X]. I suggest that [X] could be referred to as an "applet". So the HBN Speech applet contains speech activities, where each activity could be a survey with audio recording, etc.

From an editor's perspective, the additional terms "screen" and "component" are important. I recommend "screen" over "page", and would take either "component" or "widget".

Let's discuss further -- meeting now!...

akeshavan commented 5 years ago

another option:

activity set --> applet activity --> task task --> sequence of screens, each screen has a widget

akeshavan commented 5 years ago

another option:

applet --> module --> activities

binarybottle commented 5 years ago

Or "app" -- imagine the following description:

"Harvard's Psychology Department has launched a study using the 'Harvard Child Screener' app. This app has consent, survey, performance, and speech modules. The consent module has demographic questions and a quiz performed as a part of the registration process, the survey module has a set of questions to be answered weekly, the performance test module has a drawing activity and a quiz, and the speech module has instructional screens with audio recording activities."

"An editor for a given app can build one or more modules for the app, and can set a different notification schedule for each module. Each module consists of a sequence of screens, and the editor builds each screen from one or more components. For example, a speech module could consist of (1) an instructional screen containing picture, text components, (2) a sequence of survey question screens containing radio button and checkbox components, (3) an audio recording activity with text, audio recording, and comment box components, and (4) an exit screen with a thank you message in a text component."

binarybottle commented 5 years ago

New nomenclature:

app -> applet -> modules -> screens -> widgets

Editor: "I am an editor of the Harvard speech applet's modules. I build each screen of a module out of widgets. For example, I would build an instructional screen out of picture, text, and audio widgets, and for a survey screen I would include a survey widget. Other widgets include a draw widget, record audio widget, take picture widget, and comment box widget."

binarybottle commented 5 years ago

I would like to suggest that we bring back the term "activity set" but bring it down one level in the hierarchy. It makes much more sense to me to say that an applet "has activity sets" (sets of activities) than it "has modules", because you receive notifications to "do (sets of) activities", not to "do modules". An activity set contains one or more activities, such as an instructional, survey, drawing, or voice activity, and these activities are bundled together to notify the User at the same time. Changes from the previous recommendation follow:

app -> applet -> activity sets -> activities -> screens -> widgets

What do you think, @akeshavan and @shnizzedy?

binarybottle commented 5 years ago

@akeshavan and @shnizzedy -- If you don't like resurrecting the term "activity set", we could just use the term "activities" and note where necessary that activities are bundled together by theme or notification:

app -> applet -> activity -> screen -> widget

I would like to suggest that we bring back the term "activity set" but bring it down one level in the hierarchy. It makes much more sense to me to say that an applet "has activity sets" (sets of activities) than it "has modules", because you receive notifications to "do (sets of) activities", not to "do modules". An activity set contains one or more activities, such as an instructional, survey, drawing, or voice activity, and these activities are bundled together to notify the User at the same time. Changes from the previous recommendation follow:

app -> applet -> activity sets -> activities -> screens -> widgets

  • Editor: "In the editor webpage, I edit activities in the Harvard speech applet." Editor: "I am an editor of the Harvard speech applet's activities (or activity sets). I build each screen of an activity (or activity set) out of widgets..."

What do you think, @akeshavan and @shnizzedy?

binarybottle commented 5 years ago

I am working on a draft of the v2 User Guide. Until I update the figures and push to that repo, I am putting the text here for you to review (minus figure captions) to see if the proposed nomenclature is clear:

Introduction This User Guide describes four different roles for interacting with Mindlogger. Let's imagine that you want to use mobile devices to collect voice and survey data from a group of participants in a "Speech Study". You would first register on the app.mindlogger.info website, then find or create the "Speech Study" applet. As a manager of the "Speech Study" applet, you would assign people to different roles:

User: "I get notifications on my phone to take the Speech Study survey and record my voice." Viewer: "I view User's Speech Study data." Editor: "I edit the content of the Speech Study applet, such as the Speech Survey and Voice activities." Manager: "I manage User, Viewer, Editor, and Manager permissions for the Speech Study applet."

Users A User is assigned to a given project by a Manager. In the example given in the Introduction, when the User installs and opens up the Mindlogger mobile app, the User will see a Speech Study applet with a Speech Survey activity and Voice activity. The User will receive notifications set by the Manager to perform these activities.

Viewers If you want to view data for a specific User on the Viewer webpage, you must be assigned as a Viewer by the Manager. If you are the Manager, you can add yourself as a Viewer, and then you need to add Users to each Viewer. This may seem unnecessarily complicated at first, but in many large data-collection projects, we may want to distribute work to different people in the study, and we may want to keep User data private.

Before deploying your applet to real Users, it's a good idea to add yourself as a Viewer that has access to yourself as a User. That way you can take a look at the data you're collecting and make sure it meets your expectations.

Editors Editors create, edit, and curate content for a Mindlogger applet in the Editor webpage. A Mindlogger applet contains one or more activities, grouped by theme and/or notification schedule. In the example above, the Speech Study applet contains a Speech Survey activity and a Voice activity. Each activity consists of a sequence of screens; the Speech Survey activity's screens may contain instruction screens and survey questions. The Voice activity's screens may contain instruction screens, record audio screens, and a quiz. The Editor builds or edits each screen using widgets. The standard widgets that can be used for any screen include: picture, text display, audio play, and comment box widgets. Additional survey widgets include radio buttons, checkboxes, slider bar, table, etc. There is also a draw widget, voice record widget, and photo capture widget.

You can edit the name of your applet by clicking the title and subtitle and typing. The page will save automatically so you don't need to press any buttons.

You'll also see a table of activities. To create a new activity, click the "Create New activity" button in green. You can also click the name of an existing activity in the activity table.

There are also navigation buttons at the top right to quickly jump to the Manager webpage and Viewer webpage.

Each activity consists of a sequence of screens. You can see the screens at the top of the page. Each screen previews in real time, so as you edit the screen, you can get an idea of how it will look on a mobile device.

It's really important that you don't try to pack too much into a single screen! A general rule of thumb is to separate instructions from an activity.

Just like the applet panel, the edits you make to the screens are saved automatically, so you don't have to worry about losing your work.

Managers Managers assign roles for a Mindlogger applet in the Manager webpage. For example, to push an applet to a mobile device, we need to assign Users to our applet.

When you create a new applet, you are automatically assigned two roles: an Editor and Manager. Since you are a Manager, you can add a User. Once you add one or more Users to your applet, they will automatically receive your applet on their mobile devices through the Mindlogger mobile app. Before pushing your applet to real users, it's a good idea to add yourself as a User so you can test out your applet.

You can navigate to the Manager webpage either from Your Applets or from the Editor webpage. The screenshot to the right shows the four roles you can manage. In this example, I've added myself as a User to my applet. This way I can see how it looks on my mobile device.

To add a new User, start typing their email address in the text input at the bottom, and then click "Add". If the email address already has an account on our site, it will autopopulate so you can select it. If not, a new screen will pop up, asking you to create an account for a new Mindlogger User.

The panel works the same way for adding Editors and Managers. You can also use the search tool to filter the tables.

We wish you all the best in managing your first Mindlogger applet!

binarybottle commented 5 years ago

I've pushed the above to the repo -- please feel free to build locally to review until it's up on the site (some travis holdup at the moment). Please read through the text above to help think through what would be the clearest terms:

app -> applet -> activity/module -> screen -> widget

"activity" or "module"???

I was also thinking about the labels for our roles, and "Viewer" is the one that tripped up @akeshavan. Rather than say "Data viewer", how about "Inspector"?:

akeshavan commented 5 years ago

Inspector is an improvement, but not something I associated with data. What about "analyst"?

binarybottle commented 5 years ago

Your average parent will view, monitor, or inspect their child's data, not analyze it. Best to keep analysis separate, because I can see us building an analysis webpage connected to our feature extraction/analysis pipelines and data vis...

shnizzedy commented 5 years ago

https://github.com/akeshavan/mindlogger-app-admin-v2/issues/1#issuecomment-464414529 has a lot of text. I imagine this text will be illustrated with screenshots? And that these detailed instructions are a supplement to a simpler explanation elsewhere?

Re: viewer v. inspector v. analyst:

What about "user data access"? While not a single word, I think that phrase is pretty unambiguous.

binarybottle commented 5 years ago

@shnizzedy -- Yes, screenshots and figures and color -- please see https://mindlogger.anisha.pizza/#/guide

"user data access webpage" is indeed unambiguous, but we need a one-word descriptor for the person whose role is to access that webpage!

shnizzedy commented 5 years ago

Observer? ("Viewer" is what Google calls a similar role).

binarybottle commented 5 years ago

Thanks, @shnizzedy! "Observer" is not bad, and it's good to see that Google's using "Viewer" for a similar role. Does "Observer" sound creepier than "Viewer"?

I have one more to throw into the mix, which I think sounds just right: "Reviewer" -- one more syllable than "Viewer", but it conveys the idea that the person is looking over stuff as opposed to seeing it firsthand.

@akeshavan and @shnizzedy -- which do you prefer?

shnizzedy commented 5 years ago

I like "Reviewer" best of the options so far, and I think "Observer" and "Viewer" are fine.

binarybottle commented 5 years ago

Great, thanks! I'll switch to "Reviewer" in the User Guide.

@shnizzedy & @akeshavan -- What do you think about the text in the User Guide webpage (https://mindlogger.anisha.pizza/#/guide), and what do you think about "modules of activities" vs. just "activities"?