Get Started
This guide is for content designers/UAs or related roles who are creating SAP WalkMe in-app help to support BTP products and services. When you follow this guidance, you help us create a consistent in-app help experience for our customers.
In-app help is mandatory for all SAP BTP cloud applications. If your product or service includes an SAP application, then make sure to configure the right mix of in-app help using SAP WalkMe and/or SAP Companion.
Overview
WalkMe is the successor of SAP Companion for in-app help in web-based applications. It can be used to provide a variety of content to improve the onboarding experience, guide users through tasks, or highlight new features.
WalkMe content can be accessed from the WalkMe menu by choosing the “?” button in the shell bar. Some content can also be configured to "auto-play", e.g. to show a first user experience when a new user logs in to the cockpit.
The content we ship with WalkMe is also referred to as "Embedded Content" (owned and provided by SAP).
We currently provide two forms of in-app help:
- Static Help: Descriptive explanations of specific screen elements directly in the application.
- Guided Tours: Step-by-step process assistance with useful instructions and information for each step.
Collaboration Process
The following section describes the collaboration process for adding WalkMe Content to the BTP Cockpit.
Initial process for
- content creation and
- the overall collaboration and working model
With
- designers from the core design team (WalkMe UI elements, UX writing, latest standards for dialogs, help menu etc.)
- and builders (could be external company) (WalkMe builder, content building/testing) for Post-Frontrunner WalkMe in-app help
Content for BTP Fabric comes from
- central BTP cockpit EPT (Cockpit, Joule) team
- BTP cockpit contributor team
Criteria
- Ownership for content lies with each product team (responsible: UA, accountable: PM).
- For cross-scenarios, UA of the contributing product team has full responsibility for maintaining and translating the content after first release. This includes regularly checking the content and updating it if there are changes necessary.
Outlook
- The content creation and delivery tasks happen with ongoing support from experts in WalkMe content design and building, but mostly the teams should be able to operate on their own.
- Teams who have in-app help content need a colleague assigned who is fully trained and proficient in creating, building, and maintaining the content who has the required domain knowledge and can therefore make decisions on the content.
- Teams who don’t have a proficient in-app help UA can request support from a WalkMe expert.
Note: This support will be made available to the team depending on the availability of the WalkMe expert and what’s on their list.
Process Diagram
WIP (will be added later)
Resources
Find the detailed guidelines in sharepoint (WIP).