The ScreenSteps desktop editor is a word processor for creating documentation. It's simple, yet very powerful. You can create basic FAQs, straight-forward checklists, or complex workflows.
This article will walk you through the basics of using the Desktop editor. But before you begin, make sure you've already downloaded the desktop editor and set it up.
What kind of article would you like to create?
Step 1 - Write a great title
Step 2 - Grab your screenshots
Step 3 - Add your headings and paragraph text
Write Headings that are action-oriented. Use verbs like "click" or "navigate" or "fill out." If you have additional details to add, include that information as Paragraph text.
In ScreenSteps, you add blocks when you need to add content. When you need a heading, you add a Heading content block. Simply hover your mouse in the main window and a gray dot will appear > hover your mouse over the gray dot and click on the + icon.
Select the type of content you want to add. In the example below, I am selecting a heading.
Step 4 - Add your annotations
Step 5 - Publish and view your article
Step 1 - Write a great title
Step 2 - Write your main action items
Step 3 - Add your detailed notes under each checklist item
Step 4 - Include inline links to more detailed articles
One of the powerful features in ScreenSteps is the ability to include inline links. Here's an example of an inline link. When you click on it, the linked to article appears as a modal. This allows you to link out to more detailed information without feeling lost in browser windows popping up.
- Navigate to the article you want to link to and click Link
- Select inline
- Click Link
Step 5 - Publish and view your article
What else will you create?
If you are new to writing documentation and building a knowledge management system, we recommend writing a lot of "how-to" articles and a lot of "checklist" articles because those are the easiest to write AND they are the most helpful.
You can immediately start using those articles to respond to support emails or perform tasks around the office. If somebody asks, "How do I merge accounts?" You can send them the article titled, "How to merge accounts." Or if somebody asks, "What's the process for submitting travel expenses?" You can send them the checklist titled, "Submit Travel Expenses."
But don't stop there! Now that you know the basics of adding content blocks and taking screenshots, you can come up with your own variations of articles. For more ideas on what types of articles to create (and how to create them), check out these courses: