ScreenSteps

Create your first article in ScreenSteps [After trial Invite]

Updated on

Workflows are not supported in your browser.
Please use a recent version of Chrome, Edge, Firefox or Safari to display this page.

This guide will walk you through the steps of creating and publishing your first article in ScreenSteps. Just follow the steps below.

Select "Create your first article" and Enter a title

Select Create a New Article

ScreenSteps

Enter a title and then select Save

Suggested title: "How do I..(insert a question people ask frequently)?" For example:

"How do I generate a report?"

You can ignore the other fields for now. Just enter a title and select Create Article.

ScreenSteps

Open the Article QuickView

You will now see the article you just created in the list of articles for the current chapter. Click on the article title to open the QuickView window.

ScreenSteps

The Article QuickView in the Admin Portal

You are now viewing the article in the Admin Portal.

Open up the Online Article Editor

Hover the cursor over the Edit icon and select Edit on Web.

This is the Web Article Editor

There are three parts to the Web Article Editor:

  1. The Document Outline
  2. The Document Body
  3. The Formatting, Settings and Revision Note Panels
ScreenSteps

Let's add some content to the article.

Create a Heading

Select Heading from the content menu and enter a title for the heading.

For your heading you might enter "Start Here".

ScreenSteps
Click here to see what your article should look like now

Notice that the heading has appeared in our Document outline as well as the Document body.

ScreenSteps

Add a Paragraph Block

Next let's add some paragraph text. We are actually going to add two paragraphs, a normal paragraph and a styled paragraph.

Select Insert Content > Paragraph Text

  1. Click on the + icon underneath the header. This is how you can add different content types to your article.
  2. Select Paragraph Text

Add a bulleted list

You can format text and add bulleted lists using the Text formatting toolbar. This will become active when you select the

ScreenSteps
Click here to see what your article should look like now

Notice that the paragraph block is in the outline as well. The outliner will make it very easy to insert or remove content when this article needs to be updated someday.

ScreenSteps

Set the Style of the Paragraph Block

As you may have noticed, we have some paragraphs that are formatted as "Tips" in this article. Like this one!

We will now add that formatting to this paragraph.

Make sure that the paragraph is selected and then:

  1. Select the Formatting tab
  2. Set the Style of the paragraph to Tip.
ScreenSteps

Create another Paragraph Block

Now let's create another paragraph that won't be styled.

  1. Select the + icon
  2. Select Paragraph Text
ScreenSteps

Then enter some additional text.

ScreenSteps
Click here to see what your article should look like now
ScreenSteps

Publish the Article

Now let's publish the article. If you remember, we talked about the three areas of ScreenSteps:

  • The Admin Portal
  • The Published Site
  • The Desktop Authoring Client

So far we have just been working in the Admin Portal, but now we are going to see the Published Site.

First we will need to publish our updates.

 

Select Save and Publish

ScreenSteps

You should see the success message below.

ScreenSteps

View it in the Published Site

Now let's view the article in the Published Site.

  1. Select the Document Inspector
  2. Select the Published Link
ScreenSteps

You should now have a new tab open that looks like this.

Explanation of the Published Site

The published site is where you send your customers and employees to use your knowledge base. Right now you are looking at an article in the Published Site. Your users can also browser a Table of Contents or search for articles.

Tour of the Published Site

We will just highlight a few parts of this page:

  1. The breadcrumb - this allows us to quickly jump to the Site, Manual or Chapter Table of Contents. In this example, "Employee Training" is the site, "Procedures" is the manual, and "Articles" is the chapter. We will explain this hierarchy in a moment.
  2. The article body.
  3. The Edit menu. This will only for authorized authors on your account.
  4. Additional Chapters/Articles. These will appear in the sidebar and can be configured.
  5. Print/PDF options. You can turn on/off options to show Print or PDF options for articles in your site
  6. Additional manuals. In this example these other manuals are under the label "Other Resources".

The hierarchy of a ScreenSteps Site

Let's take a moment and explain the organization of content in ScreenSteps.

A ScreenSteps site is organized with the following hierarchy:

  • Manual
    • Chapter
      • Article

Let's view our list of manuals by clicking on Trial Site [Rename me] in the breadcrumb.

Click the breadcrumb to go to the Table of Contents

"Trial Site [Rename me]" is the name of the example site that is created in your trial. Clicking its title takes us to the Table of Contents. Later on you can rename your site.

My Article | Procedures | Employee Training

The Site Table of Contents

Here is the Site table of contents:

 

  1. This is the main search bar. All of the text and colors here can be customized.
  2. Here are the two manuals in our site, "Procedures" and "Policies". You can add as many manuals as you like, change the icons and the color of the manual tiles.
  3. This is the "Contact" section. You can turn this on/off as well as update the text and colors here.
  4. This is the User menu. It will allow you to logout or access the Admin Portal.

View a Manual Table of Contents

Now let's view a manual.

Click on the manual titled "Procedures".

Employee Training

The Manual Table of Contents

Here you can see the following:

  1. Manual title
  2. Chapter title (you can add additional chapters)
  3. Article titles
Procedures | Employee Training

Select your article and return to the Admin Portal

Now let's select your article again and go back to the Admin Portal.

Select Article Title

Procedures | Employee Training

Open in Admin Portal

  1. Select Edit Article
  2. Select View in Admin Portal
My Article | Procedures | Employee Training

Explanation of the Published Site vs. the Admin Portal

We are now back in the Admin Portal viewing the Article Quick View. Here we can do things such as:

  • Publish/Unpublish the article (this will show or hide it in our Published Site)
  • Download a PDF
  • Move the article to a different chapter
  • Set the Owner, Status and Tags
  • View past revisions

Next Steps

That is it for this your. We hope you have found it helpful. Visit the help site for additional help or get in touch with our team if you need anything at all.

Congratulations, you are done!

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

Still Need Help? Contact Us