Developer and Admin Help Guides

Scope

At Salesforce, I authored and updated documentation for all products in the OmniStudio application suite, which included:

  • A UI component and application builder
  • A process flows builder
  • A data tool used to read and write data to objects
  • A data process tool used for declarative, server-side processes that execute multiple actions in a single server call
  • A migration tool
  • A deployment tool

I wrote help guides, UI text, onboarding manuals, knowledge base articles, API reference docs, readmes, and release notes.

Technical Writing Samples:

Reader Profile

Administrators and developers.

Tools

  • Writing and Publishing: Initially, we used Paligo (DocBook) for writing and publishing before moving to Oxygen (Dita) for writing and Perforce for source control and publishing. Markdown and Git tool for updating developer docs such as Readmes and API docs.
  • Project Management: Initially Jira. Then, we moved to Salesforce’s GUS.
  • Content Strategy
  • Quip and Google Docs for documentation drafts and sharing information with SMEs
  • Adobe Photoshop, Figma, and Sketch for image editing
  • Snagit for screen captures
  • Lucidchart for creating technical diagrams.

SMEs

Engineers, product manager, editor, customer support, peer reviewers, and design team members.

Leave A Comment

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.