We've had countless customers tell us that they love our product, but not everyone loves our documentation. As an infrastructure company, having great docs is just as important as boosting call quality and SMS delivery rates. This is why, as part of our focus on making our product the best that it can be, we’ve put together a small task force to improve our documentation. We hope that these improvements can help ensure that everyone (i.e., seasoned and novice developers) have a great experience with Plivo.
What you can expect
Improving our docs is much easier said than done. We first set off to research and reference some of the wonderful docs that we’ve grown to love. We all know who writes them, but to internalize those styles requires much more planning and thought. So, we went back to the drawing board to highlighted the top 6 things that we think can make our docs great:
- Lower the learning curve: we often take our own knowledge for granted and forget how hard it was for each of us to learn a new platform. This is why we’re breaking down the getting started section into more foundational steps.
- Build a better foundation: by breaking down and simplifying each step, we’re also providing the opportunity to build a better understanding for our developers. Each proceeding tutorial will be a build up of the one before it.
- More comprehensive: telecom is full of technical jargon that’s important for conceptualizing how web and mobile apps interact with telecom infrastructure. Therefore, you’ll see us explain certain concepts in more detail to bring more transparency in how telecom works.
- Focus on what’s important: to highlight what’s important, we’ve added note sections to markup the essential parts to each tutorial.
- Better code markup: we’ve upgraded our syntax highlighter to include line numbers and support for more languages.
- More languages: our getting started section is full of examples, but most of it is written in Python. Indeed, we are Python folks, but you’ll now see how everything can be done in Ruby, Java, PHP, .NET, and Curl.
To start things off, we’ve added more getting started tutorials for SMS. And in the next few weeks, you can expect to see a lot more improvements.
Below is a list of new SMS tutorials that we've added:
- Send a Single SMS: Send an outbound SMS text message to any phone number. Use cases: two-factor authentication, notifications, communication apps, etc.
- Send a Long SMS: Send outbound SMS that are longer than the character limit. Use cases: surveys and polling, and group messaging, etc.
- Send Multiple (Bulk) SMS: Send multiple SMS using a single API request. Use cases: SMS marketing, emergency alerts, deals and coupons, etc.
- Alphanumeric Sender ID: Customize and brand your sender ID using alpha (a-z, A-Z) and numeric (0-9) characters.
- Receive an SMS: Receive SMS text messages in 19 countries around the world. Use cases: car share, delivery coordination, surveys and polling, two-factor authentication, etc.
- Reply to an Incoming SMS: Interact with end users using SMS text messages. Use cases: product reviews, dating apps, purchase verification, etc.
- Forward an Incoming SMS: Redirect incoming messages to another phone number. Use cases: help desks, sales teams, CRMs, etc.
- Get Details of all Messages: Find out the details of all of your SMS messages. Use cases: analytics, calculating ROI, etc.
- Get Details of a Single Message: Find out the details of a single SMS text message.
- Handling SMS Delivery Reports: Setup a webserver to handle all of your delivery reports. Use cases: customer dashboards, analytics, calculating ROI, etc.
- SMS to Email: Forward SMS text messages on your phone number to your email inbox.