ScreenSteps

Create a checklist article

Article

Checklists are a great way to write standard operating procedures. In this article, you will learn how to create a checklist in ScreenSteps.Note: Checklist articles are available in the Guide plan.

Set up your Zendesk integration

Workflow

This guide will walk you through the steps of setting up your Zendesk integration with ScreenSteps. Note: You must have a Zendesk account and a ScreenSteps account with one available site for this integration to work.

Import individual Zendesk articles into ScreenSteps

Article

This article assumes you have already set up your Zendesk integration and simply need to import individual articles from Zendesk into ScreenSteps (likely because you or your team created content directly in Zendesk as opposed to creating it in ScreenSteps and publishing to Zendesk).

Import structure (category and sections) from Zendesk HC

Article

This article will show you how to import categories and sections from Zendesk HC.

What happens if I delete a site that is connected to Zendesk?

Article

Deleting a ScreenSteps site that is connected to a Zendesk Help Center will not affect the Zendesk Help Center in any way. Only the content in ScreenSteps is affected.Links between the articles in ScreenSteps and the articles in Zendesk will be removed. The result is that updating the articles in ScreenSteps will no longer update the articles in Zendesk.For more information on what happens to articles in a site when it is deleted refer to How to Delete a Site.

Resolving Internal Links in API

Article

Internal links in ScreenSteps use data-attributes to expose the ID of the article being linked to. A typical URL might look like this:<a href="../../1/l/2-title" data-internal-link-id="24" data-internal-link="lesson" data-internal-manual-id="52" target="_blank">My link</a>This table explains the meaning of these items:

How to Update the Text at the End of the Workflow (to change it from "congratulations, you are done!")

Article

How to publish or update individual articles to Zendesk

Article

Go to the manual > chapter that contains your article. Click the action menu next to the article title . Select Push update to Zendesk HC to publish individual articles.

"Unable to initialize spell checking library" error

Article

If you see an error when launching ScreenSteps on Windows that begins with "Unable to initialize spell checking library" then your operating system is most likely missing some Microsoft files that ScreenSteps requires in order to run. To fix the issue, visit https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170 and download the x86 version of the Visual Studio 2015, 2017, 2019 and 2022 redistributable. The screenshot below shows which link you should use (accurate at the time of this writing):

How to Duplicate a Manual and Add it to Another Site

Article

In some cases, you may want to duplicate a manual and add it to another one of your ScreenSteps sites in your account.This will make a new copy of all articles and chapters in the manual. The new manual will have "(copied)" appended to the name. The chapters and articles will not be renamed.The published state of the new manual, chapters, and articles will be inherited from the content being copied.