Landing page for developer documentation

Linda Spiller | Portfolio
Developer docs

Project: SaaS company - developer documentation
Role: Technical Writer and Product Documentation Owner

Type: Enterprise developer documentation for APIs and SDKs
Format: Online
Tools: ReadMe, Stoplight, Git, Bitbucket, Mermaid.js, Visual Studio Code, Confluence, and Jira
Website URL
Changelog

Overview

For this SaaS company, I used ReadMe, Stoplight, Git, and Bitbucket to create and publish developer documentation. Except for callback pages, the reference content I created with ReadMe and Stoplight had an interactive "try it" feature. Using a docs-as-code publishing system, OpenAPI descriptions and JSON schemas were created using Stoplight’s visual API editor and merged into ReadMe’s publishing system. The team used Git, Bitbucket, and Bash scripts to integrate content and provide version control.

For all of my developer documentation projects, I collaborated with product directors, product managers, engineers, as well as key members of the customer success, sales, and legal teams. We used Jira, Slack, Zoom, Outlook, SharePoint, Miro, and Teams to collaborate and plan in an Agile environment.

Verify API - Add new channel and updates

Key tasks I did:

Added new parameters for a new channel (voice).
Added new code examples for requests and responses.
Updated parameters and sample values for SMS OTP and Push Verify channels. Updated code example tags.

What I learned:

Collaborated with new teams and SMEs.
Learned how to improve the readability of content in Stoplight.

Impact:

Customers added the new channel to their integrations.
Enabled Sales and Customer Success to support customers.
Sales landed a new customer who wanted this feature.

Messaging API - Add new endpoints for callbacks

Key tasks I did:

Added six new endpoints for a new omnichannel callback feature. Each channel (SMS, Viber, WhatsApp, MMS, Inbound SMS, and email) had a separate endpoint within the same JSON file.
Added code examples for requests.
Collaborated with PM and SME to update content in guide pages.

What I learned:

Learned about managing a large project with new endpoints in Stoplight.
Improved my ability to organize shared models in Stoplight.

Impact:

Customers are able to understand each channel's callbacks so they can successfully implement callbacks in their integrations.

Phone ID - Managed tutorial rewrite project

Key tasks I did:

I managed a project to rewrite all tutorials that had multiple languages on one page so that each tutorial had a complete set of instructions specific to a single language.
I assigned each team member tasks that built on their existing experience and allowed each to learn new skills.
I rewrote several SDK tutorials, splitting each by language.
Collaborated with SME and technical writer to update code samples.

What I learned:

Applied what I learned from the Python course that I completed last year.

Impact:

Enabled customers to easily follow instructions in tutorials. Improved readability for both developers and support teams.

Inbound SMS - Add new guide pages for the new Inbound SMS feature

Key tasks I did:

Researched and wrote four new guide pages for a new feature, Inbound SMS.

What I learned:

Learned about a unique product feature and collaborated extensively with the product manager and SME to develop easy-to-understand content to support customers.

Impact:

Key feature that allows customers to send pre-defined replies in response to certain keywords within messages to comply with regulations in certain countries.