Technical Documentation: Salesforce

View PDF of Search Documentation

Together with Salesforce’s Search Documentation team and a graphics specialist, I created help content for the Help & Training Portal about search. I first wrote three reports to identify what users need from the documentation, what users do with the software and where they might need help doing it, and what methods work best to convey that information. Then, I met with experts to learn about how search in Salesforce works. Finally, I wrote help topics to explain that information to users, I crafted a script (dialogue and actions) for a video about how search works, and I crafted another script about how to search in the new Salesforce Lightning Experience.

  • Search – The top-level page for how search works
  • How Does Search Break Up Information? and How Search Handles Terms in Chinese, Japanese, Korean, and Thai – Topics about how the search engine breaks up searchable content
  • Which Fields Are Searchable? – A set of tables for both Salesforce experiences listing which objects can be found with a search
  • How Does Search Work? – A video about how search works in Salesforce
  • Search in Salesforce: Lightning Experience – A video about how to search in the new Salesforce Lightning Experience

Additionally, I wrote a module for Trailhead, the new Salesforce learning experience. I authored it for new Salesforce administrators who have no experience with the software. I explained how to add users to a Salesforce org and how to configure the data security settings to ensure users have access to the content they need and only the content they need.

Date Written
May – August 2015

Audience
Search: Salesforce end-users using either Classic or Lightning Experience
Trailhead: Salesforce Administrators using Lightning Experience

Skills Developed

  • Learning complex topics from Subject Matter Experts
  • Conveying complex and highly technical information to a non-expert audience
  • Crafting scripts for video, including dialogue and corresponding actions