SlideShare a Scribd company logo
1 of 17
Download to read offline
An Inside Look at a Large-scale Writer-driven REST
API Doc Solution at Salesforce
October 10, 2019
Kelsey Lambert, Lead Technical Writer, Salesforce
Sejal Parikh, Product Owner, Developer-focused Content, Salesforce
This presentation may contain forward-looking statements that involve risks, uncertainties, and assumptions. If any such uncertainties materialize or if any of the
assumptions proves incorrect, the results of salesforce.com, inc. could differ materially from the results expressed or implied by the forward-looking statements we
make. All statements other than statements of historical fact could be deemed forward-looking, including any projections of product or service availability, subscriber
growth, earnings, revenues, or other financial items and any statements regarding strategies or plans of management for future operations, statements of belief,
any statements concerning new, planned, or upgraded services or technology developments and customer contracts or use of our services.
The risks and uncertainties referred to above include – but are not limited to – risks associated with developing and delivering new functionality for our service, new
products and services, our new business model, our past operating losses, possible fluctuations in our operating results and rate of growth, interruptions or delays
in our Web hosting, breach of our security measures, the outcome of any litigation, risks associated with completed and any possible mergers and acquisitions, the
immature market in which we operate, our relatively limited operating history, our ability to expand, retain, and motivate our employees and manage our growth,
new releases of our service and successful customer deployment, our limited history reselling non-salesforce.com products, and utilization and selling to larger
enterprise customers. Further information on potential factors that could affect the financial results of salesforce.com, inc. is included in our annual report on Form
10-K for the most recent fiscal year and in our quarterly report on Form 10-Q for the most recent fiscal quarter. These documents and others containing important
disclosures are available on the SEC Filings section of the Investor Information section of our Website.
Any unreleased services or features referenced in this or other presentations, press releases or public statements are not currently available and may not be
delivered on time or at all. Customers who purchase our services should make the purchase decisions based upon features that are currently available.
Salesforce.com, inc. assumes no obligation and does not intend to update these forward-looking statements.
Statement under the Private Securities Litigation Reform Act of 1995
Forward-Looking Statement
What is Salesforce?
Writers
Executives, Product Managers,
Marketers, Architects,
Engineers...
Meet the Players
Enterprise
REST API
Metadata
API
Chatter
REST API
Bulk API
Tooling API
Streaming
API
UI API
Einstein
API
Marketing
Cloud API
Commerce
Cloud API
IoT API
What’s the Opportunity?
Writers
175+
Writers
23+
REST
APIS
10
Doc
Portals
10
Authoring
Toolchains
Current State of Affairs
REST service
developer.salesforce.com
API spec
API specs
with doc
API spec
with doc
Unstructured
Doc
Unstructured
Doc
REST service
API spec
Other doc portal
API spec
with doc
Other doc portal
Unstructured
Doc
Other doc portal
Unstructured
Doc
REST service
API spec
Other doc portal
API spec
with doc
Other doc portal
Unstructured
Doc
Other doc portal
API spec
with doc
Other doc portal
Unstructured
Doc
Complete the Picture
Multi-version support
Localization
Different release schedules
Limited code access for writers
Our Goal?
● Unified automation pipeline for engineers
● Simple process and toolchain for writers
● One amazing API doc portal for customers
Step 2
Green light
Legwork
Friends of doc
The Journey
Action!
Step 3
Step 4
Step 1
Legwork
Executives
Developer
Marketing
Partnerships
● Engineering teams across the
company generate API specs
from code
● Writers and DocOps update
documentation in the API specs
● Developer marketing team
publishes the documentation to a
customer portal
API
Governance
Architecture
Strategy
Product A
Engineers
Product B
Engineers
Product C
Engineers
Product D
Engineers
Product E
Engineers
DocOps
Friends of Docs
Shared ownership of requirements across teams
High-level
requirementsStep 1
Action!
Technical
ProposalStep 2
Write User
Stories
Step 3
Move stories
to the right
backlog
Step 4
Track down
answers
Obstacles
Align
stakeholders
Secure
funding
Corral
technical
proposals
The Solution
REST service
developer.salesforce.com
API spec
API specs
with doc
API spec
with doc
Unstructured
Doc
Unstructured
Doc
REST service
API spec
Other doc portal
API spec
with doc
Other doc portal
Unstructured
Doc
Other doc portal
Unstructured
Doc
REST service
API spec
Other doc portal
API spec
with doc
Other doc portal
Unstructured
Doc
Other doc portal
API spec
with doc
Other doc portal
Unstructured
Doc
The Solution
API specs with
docs
Writers
Docs
Doc Contributions
Notifications
Raw API specs
developer.salesforce.com
REST services
Plug-and-play
solution
Doc has a seat
at the table
Go-to experts
for API docs
New
partnerships
Woohoo!
An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesforce

More Related Content

What's hot

Engineer Stunning (API) documentation
Engineer Stunning (API) documentationEngineer Stunning (API) documentation
Engineer Stunning (API) documentationPronovix
 
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...SmartBear
 
apidays LIVE India - The link between technical documentation and developer e...
apidays LIVE India - The link between technical documentation and developer e...apidays LIVE India - The link between technical documentation and developer e...
apidays LIVE India - The link between technical documentation and developer e...apidays
 
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...Nordic APIs
 
Leveraging API Docs and Tools at Mercedes-Benz /developers
Leveraging API Docs and Tools at Mercedes-Benz /developersLeveraging API Docs and Tools at Mercedes-Benz /developers
Leveraging API Docs and Tools at Mercedes-Benz /developersPronovix
 
apidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoff
apidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoffapidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoff
apidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoffapidays
 
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...Pronovix
 
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...
INTERFACE, by apidays  - The 8 Key Components of a Modern API Stack by Iddo G...INTERFACE, by apidays  - The 8 Key Components of a Modern API Stack by Iddo G...
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...apidays
 
apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...
apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...
apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...apidays
 
apidays LIVE Paris - How to position the API driven Architecture to support t...
apidays LIVE Paris - How to position the API driven Architecture to support t...apidays LIVE Paris - How to position the API driven Architecture to support t...
apidays LIVE Paris - How to position the API driven Architecture to support t...apidays
 
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypalapidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypalapidays
 
{Re}designing a Developer Portal
{Re}designing a Developer Portal{Re}designing a Developer Portal
{Re}designing a Developer PortalPronovix
 
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...Tiffany Xingyu Wang
 
apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...
apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...
apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...apidays
 
Developing a Business Case for SDKs Driven API Adoption
Developing a Business Case for SDKs Driven API AdoptionDeveloping a Business Case for SDKs Driven API Adoption
Developing a Business Case for SDKs Driven API AdoptionNordic APIs
 
APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...
APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...
APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...apidays
 
apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...
apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...
apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...apidays
 
apidays LIVE Australia - API Value Chain by Christian Raquel
apidays LIVE Australia - API Value Chain by Christian Raquelapidays LIVE Australia - API Value Chain by Christian Raquel
apidays LIVE Australia - API Value Chain by Christian Raquelapidays
 
apidays LIVE New York - API Code First vs Design First by Phil Sturgeon
apidays LIVE New York - API Code First vs Design First by Phil Sturgeonapidays LIVE New York - API Code First vs Design First by Phil Sturgeon
apidays LIVE New York - API Code First vs Design First by Phil Sturgeonapidays
 
apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guo
apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guoapidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guo
apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guoapidays
 

What's hot (20)

Engineer Stunning (API) documentation
Engineer Stunning (API) documentationEngineer Stunning (API) documentation
Engineer Stunning (API) documentation
 
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...
Standardizing APIs Across Your Organization with Swagger and OAS | A SmartBea...
 
apidays LIVE India - The link between technical documentation and developer e...
apidays LIVE India - The link between technical documentation and developer e...apidays LIVE India - The link between technical documentation and developer e...
apidays LIVE India - The link between technical documentation and developer e...
 
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
Hacks, Workarounds, and Creative Solutions: How Unsupported Use Cases Reveal ...
 
Leveraging API Docs and Tools at Mercedes-Benz /developers
Leveraging API Docs and Tools at Mercedes-Benz /developersLeveraging API Docs and Tools at Mercedes-Benz /developers
Leveraging API Docs and Tools at Mercedes-Benz /developers
 
apidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoff
apidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoffapidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoff
apidays LIVE Australia - Growing an API Culture by Liz Douglass & Saul Caganoff
 
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...
From Zero to Sixty: Driving a DocOps Based Approach to APIs at Ford Motor Com...
 
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...
INTERFACE, by apidays  - The 8 Key Components of a Modern API Stack by Iddo G...INTERFACE, by apidays  - The 8 Key Components of a Modern API Stack by Iddo G...
INTERFACE, by apidays - The 8 Key Components of a Modern API Stack by Iddo G...
 
apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...
apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...
apidays LIVE New York 2021 - Design-First: How to champion an API culture shi...
 
apidays LIVE Paris - How to position the API driven Architecture to support t...
apidays LIVE Paris - How to position the API driven Architecture to support t...apidays LIVE Paris - How to position the API driven Architecture to support t...
apidays LIVE Paris - How to position the API driven Architecture to support t...
 
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypalapidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
apidays LIVE New York 2021 - Docs Driven API Development by Rahul Dighe, Paypal
 
{Re}designing a Developer Portal
{Re}designing a Developer Portal{Re}designing a Developer Portal
{Re}designing a Developer Portal
 
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...
From Enterprise SaaS to Self-Serve Api- the S.T.R.E.A.M. Framework for API La...
 
apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...
apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...
apidays LIVE Helsinki & North - Ideas around automating API Management by Mat...
 
Developing a Business Case for SDKs Driven API Adoption
Developing a Business Case for SDKs Driven API AdoptionDeveloping a Business Case for SDKs Driven API Adoption
Developing a Business Case for SDKs Driven API Adoption
 
APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...
APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...
APIdays Paris 2019 - Improve the Security of Your APIs by Securing the API Li...
 
apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...
apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...
apidays LIVE Paris - Interface Economy: The true potential of APIs by Kristof...
 
apidays LIVE Australia - API Value Chain by Christian Raquel
apidays LIVE Australia - API Value Chain by Christian Raquelapidays LIVE Australia - API Value Chain by Christian Raquel
apidays LIVE Australia - API Value Chain by Christian Raquel
 
apidays LIVE New York - API Code First vs Design First by Phil Sturgeon
apidays LIVE New York - API Code First vs Design First by Phil Sturgeonapidays LIVE New York - API Code First vs Design First by Phil Sturgeon
apidays LIVE New York - API Code First vs Design First by Phil Sturgeon
 
apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guo
apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guoapidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guo
apidays LIVE JAKARTA - Machine Learning powered API governance by Jenks Guo
 

Similar to An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesforce

Adam Gross - The Second Decade of PaaS: What’s Next for Cloud Development
Adam Gross - The Second Decade of PaaS: What’s Next for Cloud DevelopmentAdam Gross - The Second Decade of PaaS: What’s Next for Cloud Development
Adam Gross - The Second Decade of PaaS: What’s Next for Cloud DevelopmentTuring Fest
 
Salesforce Lightning component framework from 0 to app
Salesforce Lightning component framework from 0 to appSalesforce Lightning component framework from 0 to app
Salesforce Lightning component framework from 0 to appRoy Gilad
 
Integrating with salesforce
Integrating with salesforceIntegrating with salesforce
Integrating with salesforceMark Adcock
 
The Power of Salesforce APIs World Tour Edition
The Power of Salesforce APIs World Tour EditionThe Power of Salesforce APIs World Tour Edition
The Power of Salesforce APIs World Tour EditionPeter Chittum
 
TrailheaDX Global Gathering London 2018
TrailheaDX Global Gathering London 2018TrailheaDX Global Gathering London 2018
TrailheaDX Global Gathering London 2018Keir Bowden
 
Salesforce Tour Paris - Platform Events - Martin Lezer
Salesforce Tour Paris - Platform Events - Martin LezerSalesforce Tour Paris - Platform Events - Martin Lezer
Salesforce Tour Paris - Platform Events - Martin LezerMartin Lezer
 
Introduction to MuleSoft Anytime Platform
Introduction to MuleSoft Anytime PlatformIntroduction to MuleSoft Anytime Platform
Introduction to MuleSoft Anytime PlatformSalesforce Developers
 
Build custom user interfaces for your Salesforce data with the UI API
 Build custom user interfaces for your Salesforce data with the UI API Build custom user interfaces for your Salesforce data with the UI API
Build custom user interfaces for your Salesforce data with the UI APISalesforce Developers
 
Salesforce Lightning Component Framework Roadmap (TDX18)
Salesforce Lightning Component Framework Roadmap (TDX18)Salesforce Lightning Component Framework Roadmap (TDX18)
Salesforce Lightning Component Framework Roadmap (TDX18)Developer Force
 
Modern Development with Salesforce DX
Modern Development with Salesforce DXModern Development with Salesforce DX
Modern Development with Salesforce DXSalesforce Developers
 
Using Salesforce to Manage Your Developer Community
Using Salesforce to Manage Your Developer CommunityUsing Salesforce to Manage Your Developer Community
Using Salesforce to Manage Your Developer CommunityPat Patterson
 
Sharing APIs at Scale for a Great Developer Experience
Sharing APIs at Scale for a Great Developer ExperienceSharing APIs at Scale for a Great Developer Experience
Sharing APIs at Scale for a Great Developer ExperiencePostman
 
Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...
Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...
Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...Sudipta Deb ☁
 
Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)
Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)
Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)carlos_frias
 
Modern UI development with Lightning Components - Spanish!
Modern UI development with Lightning Components - Spanish!Modern UI development with Lightning Components - Spanish!
Modern UI development with Lightning Components - Spanish!Alba Azcona Rivas
 
CCT London 2013 Theatre Intro to Apex
CCT London 2013 Theatre Intro to ApexCCT London 2013 Theatre Intro to Apex
CCT London 2013 Theatre Intro to ApexPeter Chittum
 
Spring '16 Release Notes & AppExchange 10th Birthday Bash
Spring '16 Release Notes & AppExchange 10th Birthday BashSpring '16 Release Notes & AppExchange 10th Birthday Bash
Spring '16 Release Notes & AppExchange 10th Birthday BashInternetCreations
 
Build Better Communities with Lightning
Build Better Communities with LightningBuild Better Communities with Lightning
Build Better Communities with LightningSalesforce Developers
 
Lightning Flow: The Best Feature You're Not Using
Lightning Flow: The Best Feature You're Not UsingLightning Flow: The Best Feature You're Not Using
Lightning Flow: The Best Feature You're Not UsingSalesforce Admins
 
Data Democracy: Use Lightning Connect & Heroku to Visualize any Data, Anywhere
Data Democracy: Use Lightning Connect & Heroku to Visualize any Data, AnywhereData Democracy: Use Lightning Connect & Heroku to Visualize any Data, Anywhere
Data Democracy: Use Lightning Connect & Heroku to Visualize any Data, AnywhereSalesforce Developers
 

Similar to An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesforce (20)

Adam Gross - The Second Decade of PaaS: What’s Next for Cloud Development
Adam Gross - The Second Decade of PaaS: What’s Next for Cloud DevelopmentAdam Gross - The Second Decade of PaaS: What’s Next for Cloud Development
Adam Gross - The Second Decade of PaaS: What’s Next for Cloud Development
 
Salesforce Lightning component framework from 0 to app
Salesforce Lightning component framework from 0 to appSalesforce Lightning component framework from 0 to app
Salesforce Lightning component framework from 0 to app
 
Integrating with salesforce
Integrating with salesforceIntegrating with salesforce
Integrating with salesforce
 
The Power of Salesforce APIs World Tour Edition
The Power of Salesforce APIs World Tour EditionThe Power of Salesforce APIs World Tour Edition
The Power of Salesforce APIs World Tour Edition
 
TrailheaDX Global Gathering London 2018
TrailheaDX Global Gathering London 2018TrailheaDX Global Gathering London 2018
TrailheaDX Global Gathering London 2018
 
Salesforce Tour Paris - Platform Events - Martin Lezer
Salesforce Tour Paris - Platform Events - Martin LezerSalesforce Tour Paris - Platform Events - Martin Lezer
Salesforce Tour Paris - Platform Events - Martin Lezer
 
Introduction to MuleSoft Anytime Platform
Introduction to MuleSoft Anytime PlatformIntroduction to MuleSoft Anytime Platform
Introduction to MuleSoft Anytime Platform
 
Build custom user interfaces for your Salesforce data with the UI API
 Build custom user interfaces for your Salesforce data with the UI API Build custom user interfaces for your Salesforce data with the UI API
Build custom user interfaces for your Salesforce data with the UI API
 
Salesforce Lightning Component Framework Roadmap (TDX18)
Salesforce Lightning Component Framework Roadmap (TDX18)Salesforce Lightning Component Framework Roadmap (TDX18)
Salesforce Lightning Component Framework Roadmap (TDX18)
 
Modern Development with Salesforce DX
Modern Development with Salesforce DXModern Development with Salesforce DX
Modern Development with Salesforce DX
 
Using Salesforce to Manage Your Developer Community
Using Salesforce to Manage Your Developer CommunityUsing Salesforce to Manage Your Developer Community
Using Salesforce to Manage Your Developer Community
 
Sharing APIs at Scale for a Great Developer Experience
Sharing APIs at Scale for a Great Developer ExperienceSharing APIs at Scale for a Great Developer Experience
Sharing APIs at Scale for a Great Developer Experience
 
Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...
Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...
Kitchener Salesforce Developer Group Event - Introduction to dev ops with Sal...
 
Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)
Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)
Gaing New Business Intelligence with Salesforce IQ (Salesforce World Tour NYC)
 
Modern UI development with Lightning Components - Spanish!
Modern UI development with Lightning Components - Spanish!Modern UI development with Lightning Components - Spanish!
Modern UI development with Lightning Components - Spanish!
 
CCT London 2013 Theatre Intro to Apex
CCT London 2013 Theatre Intro to ApexCCT London 2013 Theatre Intro to Apex
CCT London 2013 Theatre Intro to Apex
 
Spring '16 Release Notes & AppExchange 10th Birthday Bash
Spring '16 Release Notes & AppExchange 10th Birthday BashSpring '16 Release Notes & AppExchange 10th Birthday Bash
Spring '16 Release Notes & AppExchange 10th Birthday Bash
 
Build Better Communities with Lightning
Build Better Communities with LightningBuild Better Communities with Lightning
Build Better Communities with Lightning
 
Lightning Flow: The Best Feature You're Not Using
Lightning Flow: The Best Feature You're Not UsingLightning Flow: The Best Feature You're Not Using
Lightning Flow: The Best Feature You're Not Using
 
Data Democracy: Use Lightning Connect & Heroku to Visualize any Data, Anywhere
Data Democracy: Use Lightning Connect & Heroku to Visualize any Data, AnywhereData Democracy: Use Lightning Connect & Heroku to Visualize any Data, Anywhere
Data Democracy: Use Lightning Connect & Heroku to Visualize any Data, Anywhere
 

More from Pronovix

By the time they're reading the docs, it's already too late
By the time they're reading the docs, it's already too lateBy the time they're reading the docs, it's already too late
By the time they're reading the docs, it's already too latePronovix
 
Optimizing Dev Portals with Analytics and Feedback
Optimizing Dev Portals with Analytics and FeedbackOptimizing Dev Portals with Analytics and Feedback
Optimizing Dev Portals with Analytics and FeedbackPronovix
 
Success metrics when launching your first developer portal
Success metrics when launching your first developer portalSuccess metrics when launching your first developer portal
Success metrics when launching your first developer portalPronovix
 
Documentation, APIs & AI
Documentation, APIs & AIDocumentation, APIs & AI
Documentation, APIs & AIPronovix
 
Making sense of analytics for documentation pages
Making sense of analytics for documentation pagesMaking sense of analytics for documentation pages
Making sense of analytics for documentation pagesPronovix
 
Feedback cycles and their role in improving overall developer experiences
Feedback cycles and their role in improving overall developer experiencesFeedback cycles and their role in improving overall developer experiences
Feedback cycles and their role in improving overall developer experiencesPronovix
 
GraphQL Isn't An Excuse To Stop Writing Docs
GraphQL Isn't An Excuse To Stop Writing DocsGraphQL Isn't An Excuse To Stop Writing Docs
GraphQL Isn't An Excuse To Stop Writing DocsPronovix
 
API Documentation For Web3
API Documentation For Web3API Documentation For Web3
API Documentation For Web3Pronovix
 
Why your API doesn’t solve my problem: A use case-driven API design
Why your API doesn’t solve my problem: A use case-driven API designWhy your API doesn’t solve my problem: A use case-driven API design
Why your API doesn’t solve my problem: A use case-driven API designPronovix
 
unREST among the docs
unREST among the docsunREST among the docs
unREST among the docsPronovix
 
Developing a best-in-class deprecation policy for your APIs
Developing a best-in-class deprecation policy for your APIsDeveloping a best-in-class deprecation policy for your APIs
Developing a best-in-class deprecation policy for your APIsPronovix
 
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyoneAnnotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyonePronovix
 
What do developers do when it comes to understanding and using APIs?
What do developers do when it comes to understanding and using APIs?What do developers do when it comes to understanding and using APIs?
What do developers do when it comes to understanding and using APIs?Pronovix
 
Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsInclusive, Accessible Tech: Bias-Free Language in Code and Configurations
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsPronovix
 
Creating API documentation for international communities
Creating API documentation for international communitiesCreating API documentation for international communities
Creating API documentation for international communitiesPronovix
 
One Developer Portal to Document Them All
One Developer Portal to Document Them AllOne Developer Portal to Document Them All
One Developer Portal to Document Them AllPronovix
 
Docs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation ExperienceDocs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation ExperiencePronovix
 
Developer journey - make it easy for devs to love your product
Developer journey - make it easy for devs to love your productDeveloper journey - make it easy for devs to love your product
Developer journey - make it easy for devs to love your productPronovix
 
Complexity is not complicatedness
Complexity is not complicatednessComplexity is not complicatedness
Complexity is not complicatednessPronovix
 
How cognitive biases and ranking can foster an ineffective architecture and d...
How cognitive biases and ranking can foster an ineffective architecture and d...How cognitive biases and ranking can foster an ineffective architecture and d...
How cognitive biases and ranking can foster an ineffective architecture and d...Pronovix
 

More from Pronovix (20)

By the time they're reading the docs, it's already too late
By the time they're reading the docs, it's already too lateBy the time they're reading the docs, it's already too late
By the time they're reading the docs, it's already too late
 
Optimizing Dev Portals with Analytics and Feedback
Optimizing Dev Portals with Analytics and FeedbackOptimizing Dev Portals with Analytics and Feedback
Optimizing Dev Portals with Analytics and Feedback
 
Success metrics when launching your first developer portal
Success metrics when launching your first developer portalSuccess metrics when launching your first developer portal
Success metrics when launching your first developer portal
 
Documentation, APIs & AI
Documentation, APIs & AIDocumentation, APIs & AI
Documentation, APIs & AI
 
Making sense of analytics for documentation pages
Making sense of analytics for documentation pagesMaking sense of analytics for documentation pages
Making sense of analytics for documentation pages
 
Feedback cycles and their role in improving overall developer experiences
Feedback cycles and their role in improving overall developer experiencesFeedback cycles and their role in improving overall developer experiences
Feedback cycles and their role in improving overall developer experiences
 
GraphQL Isn't An Excuse To Stop Writing Docs
GraphQL Isn't An Excuse To Stop Writing DocsGraphQL Isn't An Excuse To Stop Writing Docs
GraphQL Isn't An Excuse To Stop Writing Docs
 
API Documentation For Web3
API Documentation For Web3API Documentation For Web3
API Documentation For Web3
 
Why your API doesn’t solve my problem: A use case-driven API design
Why your API doesn’t solve my problem: A use case-driven API designWhy your API doesn’t solve my problem: A use case-driven API design
Why your API doesn’t solve my problem: A use case-driven API design
 
unREST among the docs
unREST among the docsunREST among the docs
unREST among the docs
 
Developing a best-in-class deprecation policy for your APIs
Developing a best-in-class deprecation policy for your APIsDeveloping a best-in-class deprecation policy for your APIs
Developing a best-in-class deprecation policy for your APIs
 
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyoneAnnotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
Annotate, Automate & Educate: Driving generated OpenAPI docs to benefit everyone
 
What do developers do when it comes to understanding and using APIs?
What do developers do when it comes to understanding and using APIs?What do developers do when it comes to understanding and using APIs?
What do developers do when it comes to understanding and using APIs?
 
Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations
Inclusive, Accessible Tech: Bias-Free Language in Code and ConfigurationsInclusive, Accessible Tech: Bias-Free Language in Code and Configurations
Inclusive, Accessible Tech: Bias-Free Language in Code and Configurations
 
Creating API documentation for international communities
Creating API documentation for international communitiesCreating API documentation for international communities
Creating API documentation for international communities
 
One Developer Portal to Document Them All
One Developer Portal to Document Them AllOne Developer Portal to Document Them All
One Developer Portal to Document Them All
 
Docs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation ExperienceDocs-as-Code: Evolving the API Documentation Experience
Docs-as-Code: Evolving the API Documentation Experience
 
Developer journey - make it easy for devs to love your product
Developer journey - make it easy for devs to love your productDeveloper journey - make it easy for devs to love your product
Developer journey - make it easy for devs to love your product
 
Complexity is not complicatedness
Complexity is not complicatednessComplexity is not complicatedness
Complexity is not complicatedness
 
How cognitive biases and ranking can foster an ineffective architecture and d...
How cognitive biases and ranking can foster an ineffective architecture and d...How cognitive biases and ranking can foster an ineffective architecture and d...
How cognitive biases and ranking can foster an ineffective architecture and d...
 

Recently uploaded

Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024BookNet Canada
 
Slack Application Development 101 Slides
Slack Application Development 101 SlidesSlack Application Development 101 Slides
Slack Application Development 101 Slidespraypatel2
 
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
Snow Chain-Integrated Tire for a Safe Drive on Winter RoadsSnow Chain-Integrated Tire for a Safe Drive on Winter Roads
Snow Chain-Integrated Tire for a Safe Drive on Winter RoadsHyundai Motor Group
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsEnterprise Knowledge
 
How to convert PDF to text with Nanonets
How to convert PDF to text with NanonetsHow to convert PDF to text with Nanonets
How to convert PDF to text with Nanonetsnaman860154
 
Understanding the Laravel MVC Architecture
Understanding the Laravel MVC ArchitectureUnderstanding the Laravel MVC Architecture
Understanding the Laravel MVC ArchitecturePixlogix Infotech
 
Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...
Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...
Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...Neo4j
 
Making_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptx
Making_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptxMaking_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptx
Making_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptxnull - The Open Security Community
 
08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking MenDelhi Call girls
 
SQL Database Design For Developers at php[tek] 2024
SQL Database Design For Developers at php[tek] 2024SQL Database Design For Developers at php[tek] 2024
SQL Database Design For Developers at php[tek] 2024Scott Keck-Warren
 
Azure Monitor & Application Insight to monitor Infrastructure & Application
Azure Monitor & Application Insight to monitor Infrastructure & ApplicationAzure Monitor & Application Insight to monitor Infrastructure & Application
Azure Monitor & Application Insight to monitor Infrastructure & ApplicationAndikSusilo4
 
Benefits Of Flutter Compared To Other Frameworks
Benefits Of Flutter Compared To Other FrameworksBenefits Of Flutter Compared To Other Frameworks
Benefits Of Flutter Compared To Other FrameworksSoftradix Technologies
 
Breaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountBreaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountPuma Security, LLC
 
Human Factors of XR: Using Human Factors to Design XR Systems
Human Factors of XR: Using Human Factors to Design XR SystemsHuman Factors of XR: Using Human Factors to Design XR Systems
Human Factors of XR: Using Human Factors to Design XR SystemsMark Billinghurst
 
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...shyamraj55
 
Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365
Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365
Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 3652toLead Limited
 
Advanced Test Driven-Development @ php[tek] 2024
Advanced Test Driven-Development @ php[tek] 2024Advanced Test Driven-Development @ php[tek] 2024
Advanced Test Driven-Development @ php[tek] 2024Scott Keck-Warren
 

Recently uploaded (20)

Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
Transcript: #StandardsGoals for 2024: What’s new for BISAC - Tech Forum 2024
 
Slack Application Development 101 Slides
Slack Application Development 101 SlidesSlack Application Development 101 Slides
Slack Application Development 101 Slides
 
E-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptx
E-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptxE-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptx
E-Vehicle_Hacking_by_Parul Sharma_null_owasp.pptx
 
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
Snow Chain-Integrated Tire for a Safe Drive on Winter RoadsSnow Chain-Integrated Tire for a Safe Drive on Winter Roads
Snow Chain-Integrated Tire for a Safe Drive on Winter Roads
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI Solutions
 
How to convert PDF to text with Nanonets
How to convert PDF to text with NanonetsHow to convert PDF to text with Nanonets
How to convert PDF to text with Nanonets
 
Understanding the Laravel MVC Architecture
Understanding the Laravel MVC ArchitectureUnderstanding the Laravel MVC Architecture
Understanding the Laravel MVC Architecture
 
Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...
Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...
Neo4j - How KGs are shaping the future of Generative AI at AWS Summit London ...
 
Vulnerability_Management_GRC_by Sohang Sengupta.pptx
Vulnerability_Management_GRC_by Sohang Sengupta.pptxVulnerability_Management_GRC_by Sohang Sengupta.pptx
Vulnerability_Management_GRC_by Sohang Sengupta.pptx
 
Making_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptx
Making_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptxMaking_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptx
Making_way_through_DLL_hollowing_inspite_of_CFG_by_Debjeet Banerjee.pptx
 
08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men08448380779 Call Girls In Civil Lines Women Seeking Men
08448380779 Call Girls In Civil Lines Women Seeking Men
 
The transition to renewables in India.pdf
The transition to renewables in India.pdfThe transition to renewables in India.pdf
The transition to renewables in India.pdf
 
SQL Database Design For Developers at php[tek] 2024
SQL Database Design For Developers at php[tek] 2024SQL Database Design For Developers at php[tek] 2024
SQL Database Design For Developers at php[tek] 2024
 
Azure Monitor & Application Insight to monitor Infrastructure & Application
Azure Monitor & Application Insight to monitor Infrastructure & ApplicationAzure Monitor & Application Insight to monitor Infrastructure & Application
Azure Monitor & Application Insight to monitor Infrastructure & Application
 
Benefits Of Flutter Compared To Other Frameworks
Benefits Of Flutter Compared To Other FrameworksBenefits Of Flutter Compared To Other Frameworks
Benefits Of Flutter Compared To Other Frameworks
 
Breaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path MountBreaking the Kubernetes Kill Chain: Host Path Mount
Breaking the Kubernetes Kill Chain: Host Path Mount
 
Human Factors of XR: Using Human Factors to Design XR Systems
Human Factors of XR: Using Human Factors to Design XR SystemsHuman Factors of XR: Using Human Factors to Design XR Systems
Human Factors of XR: Using Human Factors to Design XR Systems
 
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
Automating Business Process via MuleSoft Composer | Bangalore MuleSoft Meetup...
 
Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365
Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365
Tech-Forward - Achieving Business Readiness For Copilot in Microsoft 365
 
Advanced Test Driven-Development @ php[tek] 2024
Advanced Test Driven-Development @ php[tek] 2024Advanced Test Driven-Development @ php[tek] 2024
Advanced Test Driven-Development @ php[tek] 2024
 

An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesforce

  • 1. An Inside Look at a Large-scale Writer-driven REST API Doc Solution at Salesforce October 10, 2019 Kelsey Lambert, Lead Technical Writer, Salesforce Sejal Parikh, Product Owner, Developer-focused Content, Salesforce
  • 2. This presentation may contain forward-looking statements that involve risks, uncertainties, and assumptions. If any such uncertainties materialize or if any of the assumptions proves incorrect, the results of salesforce.com, inc. could differ materially from the results expressed or implied by the forward-looking statements we make. All statements other than statements of historical fact could be deemed forward-looking, including any projections of product or service availability, subscriber growth, earnings, revenues, or other financial items and any statements regarding strategies or plans of management for future operations, statements of belief, any statements concerning new, planned, or upgraded services or technology developments and customer contracts or use of our services. The risks and uncertainties referred to above include – but are not limited to – risks associated with developing and delivering new functionality for our service, new products and services, our new business model, our past operating losses, possible fluctuations in our operating results and rate of growth, interruptions or delays in our Web hosting, breach of our security measures, the outcome of any litigation, risks associated with completed and any possible mergers and acquisitions, the immature market in which we operate, our relatively limited operating history, our ability to expand, retain, and motivate our employees and manage our growth, new releases of our service and successful customer deployment, our limited history reselling non-salesforce.com products, and utilization and selling to larger enterprise customers. Further information on potential factors that could affect the financial results of salesforce.com, inc. is included in our annual report on Form 10-K for the most recent fiscal year and in our quarterly report on Form 10-Q for the most recent fiscal quarter. These documents and others containing important disclosures are available on the SEC Filings section of the Investor Information section of our Website. Any unreleased services or features referenced in this or other presentations, press releases or public statements are not currently available and may not be delivered on time or at all. Customers who purchase our services should make the purchase decisions based upon features that are currently available. Salesforce.com, inc. assumes no obligation and does not intend to update these forward-looking statements. Statement under the Private Securities Litigation Reform Act of 1995 Forward-Looking Statement
  • 4. Writers Executives, Product Managers, Marketers, Architects, Engineers... Meet the Players
  • 5. Enterprise REST API Metadata API Chatter REST API Bulk API Tooling API Streaming API UI API Einstein API Marketing Cloud API Commerce Cloud API IoT API What’s the Opportunity? Writers 175+ Writers 23+ REST APIS 10 Doc Portals 10 Authoring Toolchains
  • 6. Current State of Affairs REST service developer.salesforce.com API spec API specs with doc API spec with doc Unstructured Doc Unstructured Doc REST service API spec Other doc portal API spec with doc Other doc portal Unstructured Doc Other doc portal Unstructured Doc REST service API spec Other doc portal API spec with doc Other doc portal Unstructured Doc Other doc portal API spec with doc Other doc portal Unstructured Doc
  • 7. Complete the Picture Multi-version support Localization Different release schedules Limited code access for writers
  • 8. Our Goal? ● Unified automation pipeline for engineers ● Simple process and toolchain for writers ● One amazing API doc portal for customers
  • 9. Step 2 Green light Legwork Friends of doc The Journey Action! Step 3 Step 4 Step 1
  • 11. Executives Developer Marketing Partnerships ● Engineering teams across the company generate API specs from code ● Writers and DocOps update documentation in the API specs ● Developer marketing team publishes the documentation to a customer portal API Governance Architecture Strategy Product A Engineers Product B Engineers Product C Engineers Product D Engineers Product E Engineers DocOps Friends of Docs Shared ownership of requirements across teams
  • 12. High-level requirementsStep 1 Action! Technical ProposalStep 2 Write User Stories Step 3 Move stories to the right backlog Step 4
  • 14. The Solution REST service developer.salesforce.com API spec API specs with doc API spec with doc Unstructured Doc Unstructured Doc REST service API spec Other doc portal API spec with doc Other doc portal Unstructured Doc Other doc portal Unstructured Doc REST service API spec Other doc portal API spec with doc Other doc portal Unstructured Doc Other doc portal API spec with doc Other doc portal Unstructured Doc
  • 15. The Solution API specs with docs Writers Docs Doc Contributions Notifications Raw API specs developer.salesforce.com REST services
  • 16. Plug-and-play solution Doc has a seat at the table Go-to experts for API docs New partnerships Woohoo!