Rippling · 2 days ago

Senior API Technical Writer

San Francisco, CA

Full-time

Remote

Senior Level

$99K/yr - $173K/yr

5+ years exp

Maximize your interview chances

EmploymentHuman Resources

Insider Connection @Rippling

Discover valuable connections within the company who might provide insights and potential referrals.
Get 3x more responses when you reach out via email instead of LinkedIn.

Responsibilities

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

Qualification

Find out how your skills align with this job's requirements. If anything seems off, you can easily click on the tags to select or unselect skills to reflect your actual expertise.

Technical WritingAPI DocumentationSoftware DevelopmentRESTful ServicesMarkdownAPI ToolsConfluenceJIRAJSONPythonMongoDBCDCKafkaSoft Skills