firetext icon indicating copy to clipboard operation
firetext copied to clipboard

First-time tutorial

Open ferndot opened this issue 12 years ago • 7 comments

Implement first-time tutorial to explain the app to new users.

Actions that should be covered (feel free to suggest more):

  • Create a document.
  • Edit a document in Raw and Design mode.
  • Add a format to text (e.g. bold).
  • Add a special element (e.g. link).
  • Delete a document.
  • Change settings.
  • Connect a cloud storage account.

Implementation notes:

  • We can use a "first.run" setting (set using https://github.com/codexa/firetext/blob/develop/scripts/settings.js#L168-L171) to tell if this is the first time that the user has launched the app.
  • The tutorial should be dismissible
  • The tutorial should be able to be launched from the Settings view.

ferndot avatar Oct 12 '13 19:10 ferndot

ok but later when we have the new enhanced workspace. We'll guide the user through an example.html template showing the features and how to use them

HR avatar Oct 12 '13 19:10 HR

http://usablica.github.io/intro.js/

HR avatar Oct 15 '13 23:10 HR

I tried that, but it does not work on mobile. Maybe it has something to do with the script causing CSP violations?

ferndot avatar Oct 18 '13 00:10 ferndot

Thanks for this link,, this change my own work project 2000% not sure useful here though. It takes a lot of real-estate

asdf23 avatar Oct 18 '13 07:10 asdf23

As a quick fix for this, it might make sense to show the Menu on first run, when no documents exist yet.

jancborchardt avatar Jun 24 '14 13:06 jancborchardt

Other potential libraries:

  • http://zurb.com/playground/jquery-joyride-feature-tour-plugin
  • http://github.hubspot.com/shepherd/docs/welcome/

ferndot avatar Jan 29 '15 15:01 ferndot

I feel like the most important thing on 1st start is to get the user to do something useful with the app. So on the desktop that could be

  • Connect a cloud storage account
  • Upload a document
  • Create a new document

So we should make all of those options easy and obvious. However, if we're trying to convince the user to do something, we should make it simpler still; for example just one screen with: "[Connect a cloud storage account!!one]
[(or upload a document)]"

(we could even always show that below the file listing.)

  • Add a format to text (e.g. bold).
  • Add a special element (e.g. link).

You could show these the first time the user opens a document. I don't know if it's necessary though.

One more point: we should make it clear that files are autosaved. A tutorial isn't the only way to do that, though.

twiss avatar Jan 30 '15 02:01 twiss