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

Confidential

Cyber Security Specialist Job at Confidential

 ...minimum 1 year of experience required Phlebotomy on all types of patients. Hard sticks and needles, urine, thyroid testing Data Entry and processing The main function of a phlebotomist is to assist in performing various assigned duties, trouble shooting, training... 

Confidential

Regional Tanker Driver Job at Confidential

 ...Description Centerline is your one access point to limitless truck driving opportunities. Our job is to connect you with safe, rewarding...  ...job opportunities with just one application our truck drivers have the opportunity to work for multiple Fortune 1000 companies... 

Bee Sweet Citrus

Production Management Intern Job at Bee Sweet Citrus

 ...Position Title Production Management Intern Company Overview Bee Sweet Citrus, Inc. is a grower, packer, and shipper of citrus and is a leader in todays agriculture industry. Bee Sweet Citrus Inc. is a family owned and operated company, providing over 10 different... 

Mayo Clinic

Manager - Supply Chain Management - Logistics Job at Mayo Clinic

 ...functional teams and provides consultative support on complex logistics issues across Mayo Clinic. Responsible for overall management...  ...analytical and technical information to plan and execute supply chain management best practices utilizing LEAN Six Sigma principles... 

NEXGENS

General Labor Job at NEXGENS

Job Summary: We are seeking a reliable and hardworking General Laborer to assist in the daily operations of our furniture manufacturing facility. The ideal candidate will be responsible for supporting various stages of production, assembly, packaging, and shipment of...