Ask HN: How much detail should I give new users during onboarding?

3 points by AndrewSwift ↗ HN
I am launching a new macOS app that requires some computer experience for installation and the basic worfklow.

Does anyone have any experience about how complete and idiot-proof program instructions should be?

    SIMPLE+ENCOURAGING VS COMPLETE+INTIMIDATING
If the instructions are brief, the program looks simple, but some people will make mistakes.

If the instructions are complete, people won't get stuck, but suddenly the process looks really complicated, even though it's not.

I started out writing very complete documentation, but pages for even simple tasks got really long. Anyone glancing at them would assume that I'm describing something really difficult.

————————————————

    To give a couple of examples:
1. install the synch app normally and launch it

or:

1. open the DMG in one window

2. open your applications folder (cmd-shift-A) in a second window

3. drag the synch application into the app folder

4. double-click it to launch

The second option is more clear, but using this style everywhere makes a simple program look very complicated.

    Another example:
1. launch the synch program and start synching

2. design normally and click "save" in the tool panel

3. when you're done, stop synching

or:

1. find the sync program in your Applications and double-click to launch it

2. select your website and click "Synchronize"

3. open a file you'd like to modify

4. when you'd like to save, click "save" in the tool panel

5. when you're done, close the file you're working on

6. go back to the synch program and press "pause" to stop synching

————————————————

Sorry to be long-winded — that's kind of the point!

My inclination is to be brief, but even with very few users I have seen some really crazy behavior.

https://svija.love if you are curious.

6 comments

[ 3.6 ms ] story [ 26.1 ms ] thread
It seems like you can just include a link to a YouTube tutorial. The users of your tool are probably the visual type.
Thanks, we are planning to do that — it will definitely mean that the pages can be simpler

But, it's a lot of work and will take months. And it makes modifying instructions complicated.

In the meantime I need to get people up and running in the next few weeks.

>But, it's a lot of work and will take months. And it makes modifying instructions complicated.

What's a lot of work and take months? Recording a video of the installation?

It's not just the installation, but how to use the product.

Offhand, I'd say that there are about 35 pages "How to do X", and I can write a simple, profesional page in about 20 minutes.

I can make an amateur video in less than an hour, but a clean, professional video is around 3 hours per item.

It wouldn't take months by itself, but in addition to my other work it will take months.

Thanks for answering. I had hoped the question would get more feedback like "we tried simple documentation but we hemorraged users" or "we spent months working on documentation and it turned out not to be useful".

I've done something similar with a team of 12 and turned it into a 30 min training. The first 15 minutes I screen shared and installed and configured it together. The last 15 was spent verifying and answering any questions. We recorded it (MS Teams) and the link was added to the instructions in the knowledge wiki for folks unable to attend. We set a must be completed by date.
Thanks, I'll look into that. It might be a good way to get going quickly.