Technical Writer (API) Job at Purple Drive, Cleveland, OH

VDlmeG5KZzR0bmZaZFhPdmlFWFJsWFFtUEE9PQ==
  • Purple Drive
  • Cleveland, OH

Job Description

Technical Writer (API)

Experience: 6-10 Years

Role Summary

We are seeking an experienced Technical Writer specializing in API documentation to create clear, accurate, and developer-friendly content. This role works closely with engineering and product teams to document REST APIs, ensuring usability, consistency, and alignment with product updates.

Key Responsibilities

  • Develop API reference documentation, conceptual guides, and tutorials for developers.

  • Document endpoints, parameters, data models, authentication methods, and error handling.

  • Maintain and update documentation to reflect new features, enhancements, and version changes.

  • Collaborate with developers, product managers, and engineers to ensure technical accuracy.

  • Use tools such as Swagger , Postman , and GitHub to manage and publish documentation.

  • Gather feedback from internal stakeholders and external developers to improve clarity and usability.

  • Review and edit documentation for consistency, quality, and adherence to standards.

Required Skills & Qualifications

  • Strong understanding of RESTful APIs, JSON, and web service architectures.

  • Proficiency in API documentation standards such as OpenAPI/Swagger.

  • Experience using Git-based version control and collaboration platforms.

  • Familiarity with at least one programming language (e.g., JavaScript, Python, or Java).

  • Excellent written and verbal communication skills with strong attention to detail.

  • Ability to translate complex technical concepts into clear, user-friendly content.

Preferred Experience

  • Experience documenting enterprise or public-facing APIs.

  • Exposure to developer portals and documentation automation tools.

Job Tags

Similar Jobs

Aramark

Cook - Turtleback Zoo F&B Job at Aramark

Do you love to cook? Are you passionate about food? As a Cook on our team, youll help bring recipes to life while being able to flex your creativity! Surrounded by fresh ingredients and the best equipment, youll be immersed in a world that goes beyond food preparation...

Hallmark University

University Nursing Instructor Job at Hallmark University

 ...Summary of the Job: Hallmark Universitys School of Nursing is currently looking for committed, creative and active faculty members who want to influence nursing student success. As a nursing faculty member, you will be responsible for engaging in the full scope of... 

arbys broken bow

Team Member - Entry Level Job at arbys broken bow

Flynn Arbys joined Flynn Group in 2018 with the acquisition of 300+ restaurants. Today we are the largest Arbys franchisee in the world and continue grow by building new stores and acquiring other franchise operators. We are one of seven premier brands of Flynn Group,...

Tanta

Anchor Host Job at Tanta

 ...Tanta Cocina Peruana, located in the vibrant River North neighborhood of Chicago, is seeking an enthusiastic Anchor Host to be the welcoming face of our restaurant! Work in a stunning space featuring a spectacular seasonal rooftop, alongside a friendly and knowledgeable... 

Confidential

Senior Telecommunications Engineer - Telecommunications Job at Confidential

 ...cost projections, and technical write-ups when required. Skills/Must have: Bachelors degree in Electrical Engineering, Telecommunications Engineering, or a related discipline, or comparable experience gained through professional work. Extensive experience in...