Last Updated September 8, 2023
Brief Overview
Standardizing the organization and naming conventions for content in the WalkMe Editor is one of the simplest steps you can take to start formalizing your Digital Adoption approach at the project level. This includes rules for naming and classifying folders, subfolders, and individual WalkMe items in both the WalkMe Editor and WalkMe Insights.
The benefits of standardization here include reduction of technical debt, less time to find items, less risk of duplicating content that already exists, and fewer maintenance headaches.
Remember: When you standardize, you are also accountable to those new standards being adopted. Designate a method of ensuring compliance with your new standards, such as checkpoints prior to publishing, and an owner, for example, the Project Lead or Program Manager.
How This Impacts Your Program
✅ Benefits of operationalizing
- Mitigates risk of changing implementation team members
- Mitigates risk of multiple siloed builder teams working in one Editor
❌ Risks of not operationalizing
- Efficiency loss
- Slowed project cycle
- Slower time to value for business stakeholders
Naming Conventions
Best practices for WalkMe items in the Editor
- Avoid adding the WalkMe application type (Smart Walk-Thru, SmartTip, etc.) as part of the name
- If a Launcher button has generic action text for your end user (for example, “Help Me”) be more descriptive with your Editor name
Tip
Here are examples of optimized naming conventions by item type:
Smart Walk-Thru
- Instead of: Create an Opportunity SWT
- Use: Create an Opportunity
SmartTip
- Instead of: Help Me
- Use: Opportunity Page Mini-Menu
Launcher
- Instead of: Invisible Launcher
- Use: Opportunity “Save” Validation Gate
Note
If an item appears in the WalkMe Menu (for example, a Smart Walk-Thru, Resource, or Survey), the name in the Editor will be the same as the name your end-users see, unless you have specific features that allow for separate, internally-facing naming conventions.
Behavioral analytics softwares like Segment and Mixpanel promote the Object – Action model to help ensure your Engaged Elements and/or Tracked Events are concise, consistent, and easy to understand.
Given the complexity of many of the systems you may be working with (compared to a mobile application, or consumer application) we recommend calling out the specific Process as well.
- Use the Process – Object – Action model
Tip
Here are examples of Tracked Events using the Process – Object – Action framework:
- Invoicing – Request new PO Form – Page View
- Invoicing – Request new PO Form – Clicked
- Invoicing – Submit new PO Form – Clicked
Note
Clear and consistent naming conventions are especially important if you are sending Tracked Events and/or Engaged Elements data to IT or Product stakeholders. This can reduce confusion and eliminate need for extra communication between stakeholders and the Digital Adoption team.
Editor Folder Management
Best practices here include:
- Standardize folder types by module or process instead of by Builder or phase
- Standardize abbreviations
- Consider your extent of subfolder use (set up sparingly with maintenance and potential changing Builders in mind)
Get Started: Checklist to Standardize
The following are considerations when creating a Standard Operating Procedure in this area:
Naming Conventions Checklist
☐ What are my standards for naming individual Folders & Subfolders?
☐ What are my standards for naming individual WalkMe items (including Engaged Elements)?
☐ Have I considered that some deployable names are visible to my end-user in the menu?
☐ What are my standards for naming Tracked Events in Insights?
☐ What are my standards for naming Segmentation tags?
☐ What are my standards for naming Adoption Projects?
☐ What are my standards for naming Reports when using the Report Builder?
Pre-Publish Checkpoints Checklist
☐ What is my process for ensuring solutions abide by these standards?
☐ Who is responsible for checking the solutions, and at what stage of the process?
☐ What is my process for auditing my Editor(s) after go-live to ensure they are compliant? How often does this type of review happen?
Administration Checklist
☐ How are these procedures documented to prioritize scale and reduce administrative time?
☐ How often are they reviewed?
☐ Who is responsible for enforcing them?
☐ If there are proposed changes to the procedures, who approves those changes?
☐ How will we know if the rollout of these standards has been successful? Do we have a clear way to measure success? Do we have a clear feedback loop?
☐ If there are changes/additions to these procedures, who is responsible for communicating them? How are the changes communicated/who are they communicated to?
Connect with Peers via the WalkMe Community
