Technical Writer, API

$84,000 - $147,000/Yr

Rippling - San Francisco, CA

posted 4 months ago

Full-time - Mid Level
San Francisco, CA
Publishing Industries

About the position

The Technical Writer, API role at Rippling offers a unique opportunity to leverage your software development experience and strong technical writing skills to create accurate and user-friendly developer documentation. This position is part of Rippling's Customer Education team, which is dedicated to building best-in-class help documentation and on-demand training materials to assist customers in utilizing every aspect of the Rippling platform effectively. As a Technical Writer, you will play a critical role in driving developer adoption of Rippling's API, Flux, and future developer-facing products. Developers will rely on your documentation to build custom integrations that run on Rippling's infrastructure and are distributed through the App Shop. These integrations will automate business processes by utilizing APIs that interact with Rippling's core resources through REST. In this role, you will be responsible for creating and maintaining high-quality API documentation, which includes reference guides, developer guides, and tutorials. You will collaborate closely with product and engineering teams to ensure that the documentation is accurate and user-friendly. Additionally, you will create and maintain a library of sample code examples and snippets, ensuring that all documentation adheres to the company's style guidelines and follows industry best practices. Your work will involve organizing and structuring the API documentation, keeping it up-to-date with the latest API releases, changes, and improvements. You will also evaluate API design and provide feedback to enhance the clarity, consistency, and usability of API interfaces. Advocating for developer-friendly APIs, you will suggest improvements in API naming, versioning, error handling, and response formats. Furthermore, you will document custom programming languages within the Rippling Platform and develop code samples and use cases that demonstrate proper integration and usage of APIs. Engaging actively with developers, partners, and clients, you will gather feedback on the API documentation and incorporate improvements based on user needs. This role will also involve working alongside software architects and senior developers who are engaged in state-of-the-art development work.

Responsibilities

  • Create and maintain high-quality API documentation, including reference guides, developer guides, and tutorials.
  • Collaborate with 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.

Requirements

  • 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.

Benefits

  • Competitive salary
  • Equity options
  • Comprehensive health benefits
  • Flexible work environment
  • Opportunities for professional development
© 2024 Teal Labs, Inc
Privacy PolicyTerms of Service