27 July - Step description deprecated

This article is from before the rebranding to SelfGuide. Text and images can include the old product name ProductivityPerformer or its abbreviation PP.

Unambiguous content as well as an intuitive interface helps users to learn quick. To increase this learning ability, the step description field will be removed in the future. In this release, the usage of the step description is changed so no new step descriptions can be added. Also, it is encouraged to migrate and cleanup the existing step descriptions. Read more about this change and other changes below.

Step description deprecated

The step description is used to add contextual information to a step, for example an explanation or a relevant corporate policy. This field has been available from the beginning of SelfGuide and is still often used, however a better option is available. To help improve the content created by editors, we have chosen to deprecate the step description functionality and remove the field later this year. Read more about the reason and timeline in the knowledge base.

In this release, the usage of the step description is changed:

  • No new step descriptions can be added. Steps without a step description won't show the field, the title field gains the entire width
  • Existing step descriptions are read-only with two possible actions: copy to clipboard and remove. The copy to clipboard action gives the ability to reuse the information from the step description, for example in an annotation or in the step title. Remove can be used to clear the step description field so the step is inline with future usage.

To encourage migrating information out of the step description, a warning is shown to editors when the step description is used on a step. This can be seen below.

Minor updates

  • The course library did not contain a background image, decreasing the visibility of the tiles