Technical Writer

Posted:
12/4/2024, 12:40:55 AM

Experience Level(s):
Junior ⋅ Mid Level ⋅ Senior

Field(s):
Software Engineering

Workplace Type:
Remote

Vonage Mission

Vonage API is the emerging leader in the $100B+ cloud communications platform (CPaaS) market. Customers like Airbnb, Viber, TikTok, Snapchat, and many others depend on our APIs and SDKs to connect with their customers all over the world. As businesses continue to shift to a real-time, customer-centric communications model, we are experiencing a time of impressive growth.

Why this role matters

Technical Writers at Vonage help author high-quality developer-focused documentation delivered on the Vonage API Developer Platform (developer.vonage.com). 

As a technical writer at Vonage, you will work as part of a team dedicated to providing API developers with all the tools and knowledge necessary to integrate their applications with Vonage’s Communication APIs. You will be responsible for creating and maintaining documentation for the Vonage API Developer Portal. Your contributions will be integral in supporting Vonage’s commitment to providing the best developer experiences through the quality of the content delivered on the API Developer Portal. You’ll be working as part of a remote-first team that has years of experience with virtual collaboration across multiple countries and time zones.

 

What you'll do

  • Apply a documentation as code approach to technical authoring. 
  • Create functional and technical documentation for developers who integrate with Vonage Communication APIs.
  • Contribute to the technical content strategy with other stakeholders including members of the Developer Relations and Product teams.
  • Translate API product technical specifications into developer-enabling documentation.
  • Write code examples that demonstrate how to build solutions that integrate with Vonage API products.
  • Maintain knowledge of and interact with Vonage Communication APIs to ensure the accuracy of the documentation.
  • Ensure ease of contribution to  API Developer Portal through providing clear contribution guidelines and direct coaching.
  • Collaborate with other Vonage employees and community contributors on documentation.
  • Integrate developer feedback continuously into your plans and documentation.
  • Encourage people across the Vonage organization and the developer community to contribute to the API Developer Portal.
  • Ensure ease of contribution to  API Developer Portal through providing clear contribution guidelines and direct coaching.
  • Help Vonage become recognised for excellent developer experience through highly usable and open-sourced documentation.

What you'll bring

We believe variety helps seed creativity. So, as part of the Vonage API Developer Portal team, responsibilities may also include:

  • Providing feedback on APIs, SDKs, documentation and product functionality
    • Individual opinion and insight
    • Via discussions with the developer community
  • Building and maintain open source code examples and demonstration apps
  • Representing Vonage at events
    • Hackathons
    • Sponsorship booths
    • Meetups
    • Conferences
    • Talks
  • Providing support via social channels such as Twitter, StackOverflow the Nexmo Community Slack, and encourage issues to be raised on GitHub
  • Supporting early adopters and key customers with integrations
  • Creating opportunities for other Vonage employees to engage with the developer community
  • Helping with recruitment through referral of strong technical candidates for roles at Vonage

What's required for application

Required 

  • Ability to author content with the developer’s perspective in mind.
  • Demonstrated experience writing technical documentation for REST/Web APIs.
  • Knowledge of SaaS/PaaS products.
  • Experience authoring documentation in Markdown.
  • Experience using Git and GitHub to collaborate with other team members.
  • Knowledge of one of the following languages: JavaScript, Ruby, Python, or PHP.

Preferred

  • Understanding of Swagger/OpenAPI v3, API Blueprint or RAML.
  • Experience as a developer or developer advocate.

What's in it for you

In addition to providing exciting work, career advancement opportunities, and a collaborative work environment, Vonage provides competitive pay and benefits including unlimited discretionary time off and tuition reimbursement.

 

Note: The purpose of this profile is to provide a general summary of essential responsibilities for the position and is not meant as an exhaustive list. Assignments may differ for individuals within the same role based on business conditions, departmental need or geographic location.

#LI-KP

Vonage

Website: https://www.vonage.com/

Headquarter Location: Holmdel, New Jersey, United States

Employee Count: 5001-10000

Year Founded: 2001

IPO Status: Public

Last Funding Type: Post-IPO Debt

Industries: Communications Infrastructure ⋅ Developer APIs ⋅ Enterprise Applications ⋅ Information Services ⋅ Information Technology ⋅ PaaS ⋅ Telecommunications