Recent updates
-
Organizing manuals in Categories
Updated on Oct 02, 2020ArticleThis 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.
Setting Up ScreenSteps / Organizing Content / Categories
-
Create and Organize Documentation
Updated on Sep 30, 2020ArticleIn this webinar, we'll walk you through creating new articles in ScreenSteps and discuss different approaches to organizing your documentation.
Additional Help Resources / Best Practices / List of videos
-
Configure SAML Settings in ScreenSteps for Salesforce
Updated on Sep 30, 2020ArticleRefer to the instructions in How do I remotely authenticate a user using ScreenSteps Remote Authentication? for creating a Single Sign-on endpoint. Make sure to select SAML as the mode when creating the endpoint.
Additional Help Resources / Salesforce and ScreenSteps / Single Sign-On with Salesforce (SAML) Articles
-
Provide Feedback to Editors (using notes)
Updated on Sep 17, 2020ArticleYou can include notes and author feedback on individual content blocks.
Using ScreenSteps / Authoring Content / Working with a Team of Authors
-
ScreenSteps and Zendesk Authoring Permission Groups
Updated on Sep 17, 2020ArticleIn 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."}
Setting Up ScreenSteps / Integrations / Zendesk Integration
-
Getting Feedback on Specific Manuals
Updated on Sep 17, 2020WorkflowWhen 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.
Using ScreenSteps / Authoring Content / Working with a Team of Authors
-
How do I rename an article?
Updated on Sep 17, 2020ArticleYou can rename an article from within the Admin area by clicking on the edit icon to the right of the article title.
Using ScreenSteps / Authoring Content / Writing Articles
-
How to view revision notes and other activity for an article
Updated on Sep 17, 2020ArticleThe 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.
Using ScreenSteps / Authoring Content / Working with a Team of Authors
-
Create a New Workflow Article
Updated on Sep 17, 2020Article- Enter a title
- Select Workflow
- Click "Create Article"
Using ScreenSteps / Authoring Content / Workflow Articles
-
See Activity For Individual User
Updated on Sep 17, 2020ArticleScreenSteps includes viewing analytics on the Small Business Plan and above. Viewing analytics is to be used on internal documentation. Public facing knowledge bases are recommended to use Google Analytics.
Using ScreenSteps / Admin Tasks / Reports