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

QXpDVFlnWGZFTTZKWkZZZWF0eUN6ZnVqN0E9PQ==
  • 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

Evolution Safety Resources

Safety Manager Job at Evolution Safety Resources

 ...Evolution Safety Resources (ESR) is a leading national workplace safety consulting and staffing firm headquartered in Raleigh, NC. ESR...  ...compliance across multiple client sites, fostering a culture of safety, trust, and practical solutions. This full-time, permanent position... 

Domino's Franchise

Delivery Driver Job at Domino's Franchise

 ...Job Description Join Dominos as a delivery driver today! Being the best pizza delivery company in the world requires exceptional team members working together. At Domino's Pizza, our people come first! Deliver amazing food with exceptional hustle and a great attitude... 

Franciscan Sisters of Perpetual Adoration

Liturgy and Musician Job at Franciscan Sisters of Perpetual Adoration

 ...Opportunities.Join the Franciscan Sisters of Perpetual Adoration mission and ministry. We are seeking a full-time Liturgist and Musician to join our team at St. Rose Convent, the spiritual heart and administrative center of FSPA in La Crosse, WI. Visit us at As the... 

City of Garland

Equipment Operator I Job at City of Garland

 ...experience) Essential Duties and Responsibilities include the following. Other duties may be assigned . Operate 12-yard dump truck. Identify equipment needs for each assigned project. Transport all equipment and materials between job sites. Maintain street... 

Federal Express Corporation

Package Handler - Part Time (Warehouse like) Job at Federal Express Corporation

 ... EEO Statement Federal Express Corporation is an Equal Opportunity Employer including, Vets/Disability. Reasonable accommodations are available for qualified individuals with disabilities throughout the application process. Applicants who require reasonable...