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

St. Dominic Parish

Music Director Job at St. Dominic Parish

St. Dominic Parish in Oyster Bay is seeking a Director of Music Ministry. This is a full-time position including weekend masses, and must be flexible with work schedule, especially for Holy Days and special events. The Director of Music Ministry should be a committed Roman... 

AO Globe Life

Immediate Hire: Fully Remote Position (No Experience Needed - Start ASAP) Job at AO Globe Life

 ...Week Interview in 2448 Hours!100% Work From Home | Flexible Hours | Remote Position Join...  ...is needed you can start earning immediately with our quick onboarding process. Position...  ...Schedule Choose Your Hours ~ Fast Hiring Process Interview & Start in 2448... 

Confidential

Cleaner Job at Confidential

 ...This is a 4-week project where candidates are needed to help deep clean the kitchen area. Responsibilities include cleaning walls,...  ...housekeeping or janitorial roles. Familiarity with sanitizing and industrial cleaning processes. Why Work Here? Join one of the largest... 

Mayo Clinic

Clinical Nurse Specialist-Outpatient Neurology/Neurosurgery/Spine Center and PM&R - CNS Job at Mayo Clinic

 ...City Rochester State MN Remote NO Department Nursing Why Mayo Clinic Mayo Clinic is top-ranked in more specialties than any...  ...future. Responsibilities The Clinical Nurse Specialist (CNS) works collaboratively to improve the quality of patient... 

LTC Language Solutions

Swahili Interpreter - Indianapolis, IN Job at LTC Language Solutions

Are you fluent in both English and Swahili? Do you have experience working as an interpreter? LTC is an interpreting agency looking for contracted Swahili language interpreters in Indianapolis. You will accept appointments on an as needed basis. The ideal interpreter ...