Technical Writer, API

Salary

$0.0008399999999999999k - $0.00147k

Min Experience

5 years

Location

San Francisco, CA, New York, NY, Austin, TX, remote

JobType

full-time

About the role

The Technical Writer, API role on Rippling’s Customer Education team provides a unique opportunity to use your software development experience and strong technical writing skills to build accurate and user-friendly developer documentation. You will play a critical role in helping to drive developer adoption of Rippling’s API, Flux, and future developer-facing products. What you will do Create and maintain high-quality API documentation, including reference guides, developer guides, and tutorials Collaborate with our product and engineering teams to develop accurate and user-friendly API documentation Create and maintain a library of sample code examples and snippets Ensure that API documentation adheres to the company's style guidelines, is user-friendly, and follows industry best practices Work closely with product managers and subject matter experts to understand the API's functionality, use cases, and target audience Organize and structure the API documentation Keep the API documentation up-to-date with the latest API releases, changes, and improvements Evaluate API design and provide feedback to improve the clarity, consistency, and usability of API interfaces Advocate for developer-friendly APIs by suggesting improvements in API naming, versioning, error handling, and response formats Document custom programming languages within the Rippling Platform Develop and maintain code samples and use cases that demonstrate the proper integration and usage of APIs Ensure that the provided examples align with best coding practices and are relevant to real-world scenarios Actively engage with developers, partners, and clients to gather feedback on API documentation and incorporate improvements based on user needs. Work alongside software architects and senior developers doing state-of-the-art development work What you will need 5+ years of experience as a Technical Writer, with a focus on API documentation 2+ years of experience in a software development role Experience writing effective technical content for a developer audience using Markdown Strong understanding of APIs, RESTful web services, and programming concepts Proficiency with various authoring, CMS, and task management tools Proficiency in writing clear, concise, and well-structured technical documentation Familiarity with API documentation tools, such as Swagger, Postman, or similar. Experience with Confluence, JIRA, and JSON. Experience using tech stacks like Python, MongoDB, CDC, and Kafka Experience working in a fast-paced, dynamic environment Ability to thrive in an environment that grants you a lot of autonomy to explore creative solutions

About the company

Rippling is the first way for businesses to manage all of their HR & IT—payroll, benefits, computers, apps, and more—in one unified workforce platform. By connecting every business system to one source of truth for employee data, businesses can automate all of the manual work they normally need to do to make employee changes.

Skills

API documentation
Markdown
RESTful web services
Python
MongoDB
CDC
Kafka
Swagger
Postman
Confluence
JIRA
JSON