Template: User Article

Here's where we tell the user what the benefits of using this feature or following these instructions. Put yourself in their shoes: as a user, they probably deal with a lot of different apps and software. Write in a way that lets them know that they will easily and clearly find the help they need. 

 Key features

• You can do this
• You can do that
• It makes your life better!

You need this to succeed

• This is a list of prerequisites
• It is great to list what package they need if applicable

The quick way to awesomeness

• This is a quick checklist
• With no screenshots
• Short instructions
• For the "learner on the go"

Choose your success platform

iOS

Android

Windows(Legacy)

Windows Desktop

Web app

See how it's done on iOS

1. This is the "Do this step by step" section on iOS
2. A series of instructions
3. Craft your screenshots to be helpful and clear.

See how it's done on Android

1. This is the "Do this step by step" section on Android.
2. A series of instructions.
3. Craft your screenshots to be helpful and clear.

Note: Here's the code and formatting for a call-out note. These should be used sparingly when there's an important piece of info that the user should know at this point in the instructions. 

See how it's done on the Windows (Legacy) app

Now you're starting to get the picture! Follow the same format as iOS and Android - only for the Windows (Legacy) app.

See how it's done on the Windows Desktop app

If there is a larger amount of information that can be placed into sections, you can do so by using subheaders. There is also an example of what a gif looks like in action in this sample section:

Activating Email Notifications

1. Navigate to the Share page and select the Emails & Links tab.
2. Click the toggle for Email notifications to enable.

   Note: Every 5 minutes our system checks if your Share was opened. If your prospect interacts at least 3 minutes with your content, you will receive the notification via email. 

Stopping Email Notifications

There are 2 options to disable Email notifications.

1. Navigate to the Share page and select the Emails & Links tab. Deactivate the Email notifications toggle.
2. In the Share tab of the Web app, click the Share you'd like to stop receiving notifications for. Click the settings gear on the top right, then select Stop all notifications.

See how it's done on the Web app

You seem to be understanding this pretty well, soldier! Here's a final, simple text-only example of the format for the step by step instructions:

1. First, do this
2. Then do that
3. And then this

If you need to split things up, you can do this with linking to anchor points: 

Do this step by step

1. Go to step 1
2. Go to step 2

 

---

Step 1

You made it to step 1!

Back to Top

---

Step 2

Wow, step 2. Impressive!

Back to Top

---