Organizing manuals in Categories

Article

This article will show you how to organize manuals in categories within your site. When you add a category, any manuals under the category will appear within the category.

Create and Organize Documentation

Article

In this webinar, we'll walk you through creating new articles in ScreenSteps and discuss different approaches to organizing your documentation.

Configure SAML Settings in ScreenSteps for Salesforce

Article

Provide Feedback to Editors (using notes)

Article

You can include notes and author feedback on individual content blocks.

ScreenSteps and Zendesk Authoring Permission Groups

Article

In February 2019 Zendesk first began requiring that a permission_group_id be set for newly created articles. In order for ScreenSteps to send a permission group to Zendesk when creating articles you will need to set the Default Zendesk Authoring Permission Group in the ScreenSteps Site settings. All new articles created in Zendesk from ScreenSteps will be set with this authoring permission.

You may need to do this if you see the following error:

Zendesk HC error: {"title":"Invalid attribute","message":"You passed an invalid value for the permission_group_id attribute. You must provide permission_group_id."}

Getting Feedback on Specific Manuals

Workflow

When you're working with a team of reviewers, you have a few different options for receiving their feedback.

You can have reviewers look at your ScreenSteps content:

• In a PDF document
• As an Editor
• As an End-user

What you do depends on your ScreenSteps plan level and what kind of access you want to give to your reviewers.

In a PDF document
You can choose to export your content as a PDF document and send it to your reviewers. This is the simplest way if you don't want to give your team of reviewers access to ScreenSteps. Reviewers will leave notes on the PDF and you will need to incorporate the suggestions in ScreenSteps.

As an Editor
If you decide to give your reviewers Editor access, your reviewers can take advantage of the revision notes features, article assignments, and article status; however, if you are concerned about reviewers making edits to the actual content, then there are options for you to restrict Editor permissions (e.g. Editors can edit but not publish nor delete).

As an End-user
You can create Reader accounts for your reviewers so they can look at your content in a published ScreenSteps site. The benefit of this is that your reviewers cannot modify content, but they can leave comments at the bottom of the article (if that feature is turned on for that site). The easiest way to accomplish this is to 1) create a "Staging" site 2) share specific manuals to that site 3) add your reviewers as Readers to that site.

Instructions for doing any of those options can be found below.

How do I rename an article?

Article

You can rename an article from within the Admin area by clicking on the edit icon to the right of the article title.

How to view revision notes and other activity for an article

Article

The Activity Stream shows a history of who modified an article and when. The activity stream can contain notes about changes that were made to an article as well. The Activity Stream is available in the web application only.

Revision notes are notes that can be added to an article (or specific content blocks within the article) in order to communicate with other authors about changes that need to be made. Revision notes can be created and viewed in the web or desktop editor.

Create a New Workflow Article

Article

1. Enter a title
2. Select Workflow
3. Click "Create Article"

See Activity For Individual User

Article