Unclassified - San Francisco, CA

posted 4 months ago

Full-time - Senior
San Francisco, CA

About the position

The Senior API Technical Writer role at Rippling offers a unique opportunity to leverage your software development experience and technical writing skills to create accurate and user-friendly developer documentation. As part of the Customer Education team, you will play a critical role in driving developer adoption of Rippling's API, Flux, and future developer-facing products. Your work will involve creating and maintaining high-quality API documentation, including reference guides, developer guides, and tutorials that help developers build custom integrations on Rippling's infrastructure. These integrations are distributed through the App Shop, allowing customers and partners to automate business processes using APIs that interact with Rippling's core resources via REST. In this role, you will collaborate closely with product and engineering teams to ensure that the API documentation is not only accurate but also adheres to the company's style guidelines and follows industry best practices. You will be responsible for organizing and structuring the API documentation, keeping it up-to-date with the latest API releases, and evaluating API design to provide feedback that enhances clarity and usability. Additionally, you will advocate for developer-friendly APIs by suggesting improvements in naming, versioning, error handling, and response formats. Your engagement with developers, partners, and clients will be crucial in gathering feedback and incorporating improvements based on user needs. This position requires a strong understanding of APIs, RESTful web services, and programming concepts, along with proficiency in various authoring and task management tools. You will also be expected to develop and maintain code samples and use cases that demonstrate proper integration and usage of APIs, ensuring that examples align with best coding practices and real-world scenarios. Working alongside software architects and senior developers, you will contribute to state-of-the-art development work while fostering a collaborative environment that drives product adoption and customer success.

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
  • Health insurance
  • Paid time off
  • Flexible work schedule
  • Professional development opportunities
© 2024 Teal Labs, Inc
Privacy PolicyTerms of Service