ScreenStepsGetting Started Onboarding GuidesEvaluating ScreenSteps--Part 3: Create Content

Evaluating ScreenSteps--Part 3: Create Content

Step 3: Create Content

Now you are going to create some content. You will first create 3 help articles, and then you will edit each article to add content (text, screenshots, etc.).

Create 3 articles

Select a manual

Click the + icon

Add a title > Create article

  1. Make the title something simple, such as "How to View Billing Information"
  2. Create article

Continue creating articles until you have 3 or 4 total articles.

Edit an article

There are 4 steps to editing an article. Below is a video overview (and the steps for editing an article are below that).

Step 1: Edit Contents

Edit article on Desktop

  1. Click on the dropdown arrow next to the article's title
  2. Click Edit on Desktop

If you have not yet downloaded the ScreenSteps desktop client, now is the time to do that. click the "Download the Desktop Client" link below.

Download the Desktop Client

Download the version that matches your operating system (Mac or Windows). 

Download the ScreenSteps desktop client for Mac by >> clicking here.

Download the ScreenSteps desktop client for Windows by >> clicking here.

Now that you have the desktop client downloaded, you can create help articles in a fraction of the time.

Step 2: Add screenshots

Open Capture palette

Click on the capture palette icon to open the capture palette.

Take screenshots

Navigate to the area you want to take screenshots of (e.g. your web application).

Click the crosshairs on the capture palette and your mouse will turn into crosshairs. Click and drag your mouse to select an area that you want to capture, then hit Enter. The screenshot is copied and pasted into your article.

You can take as many screenshots as you'd like--ScreenSteps will copy and paste all of them into the article for you.

Close the capture palette when you are done

Step 3 - Add annotations

Make your screenshots really helpful by adding annotations (e.g. arrows, circles). This is only available in the desktop application.

Select an image in the editor > choose the arrow

Try a few other annotations so you can get an idea of what's available.

Draw on the image

Click your mouse on the screenshot, and drag your mouse to draw an image (such as an arrow).

Step 4 - Add headings and text

The final step is to add a heading for each screenshot that explains what action to take.

Add a heading

As you move your mouse in the editor, you will see a gray bubble:

  1. Move your mouse to the gray bubble
  2. Click on the + icon
  3. Select Heading

Don't be shy--play around with the editor and try different features. Once you are comfortable with the editor, you can check out our bonus material below for creating articles.

Add a descriptive action for each screenshot

Add a heading over each screenshot and type in a descriptive action such as "Click on Account" and "Click on Users."

Add Text

Add paragraph text the same way--move your mouse over a gray bubble, and click Text. You can include plain text, or you can style it.

Style your text

Create styled text by:

  1. Clicking in a text field
  2. Selecting a style on the right-hand side
Publish your article

When you are done editing your article, you can publish it to your knowledge base and share it with your customers.

Click Save & Publish

Click Publish

You have options to message your documentation team. For now, don't worry about that. Just click Publish.

View the article in your knowledge base

You can also preview your entire knowledge base

After you close the desktop application (i.e. desktop article editor), you can always check out your knowledge base by clicking on:

  1. Site Contents
  2. Open Preview

You just used the ScreenSteps desktop client to author an article. After you close it, you will go back to your web browser to access the ScreenSteps browser application.

Next Step >> Check Out the Bonus Material

Now you know the basics! We have some bonus material you can check out to learn more about best practices for organizing and creating documentation.

Click here to learn how to >> Organize your knowledge base

2 Comments

Alberto Azevedo

How did u do the animated gif?

Trevor DeVore

@Alberto - take a look at licecap: http://www.cockos.com/licecap/

Add your comment

E-Mail me when someone replies to this comment