Skip to main content

API reference

Sendbird | October 2022

Markdown VSCode GitHub Postman

Project overview​

As a technical writer at Sendbird, a leading B2B chat platform, I documented a new feature called Polls, which enables users to create and vote in polls directly within chat conversations.

Note: All content was written by me, except for the code samples.

Scope of work​

  • Wrote a comprehensive feature overview and 12 API reference guides for supported actions.
  • Ensured technical accuracy by collaborating closely with engineers and product stakeholders and using Postman to to test and confirm endpoint behavior under various conditions.

Outcome​

  • Deployed the documentation in sync with the feature release, contributing to a smooth developer onboarding experience.
  • Led the end-to-end documentation process, from draft to release, maintaining clarity, accuracy, and alignment with company standards.

screenshot of Polls API overview page screenshot of Create a Poll API page