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

Spieldenner Financial Group

Field Underwriter (Remote) Job at Spieldenner Financial Group

Spieldenner Financial Group is a financial services company serving mid-market families that work hard to provide a life and lifestyle worth protecting from the everyday worries of life. We help them by putting a shield of protection between their families and the financial...

Domino's Franchise

Delivery Driver - 9631 Giles Rd. Job at Domino's Franchise

 ...dreams become reality! Dominos, the industry leader in pizza delivery, is looking for enthusiastic and reliable Delivery Drivers to...  ...Competitive Pay & Perks: Hourly wages + tips + mileage reimbursement add up fast. Team members 18+ also have access to next-day pay through... 

ComForCare Home Health Care - Baltimore/Carroll

Administrative Coordinator Home Care Job at ComForCare Home Health Care - Baltimore/Carroll

 ...Pay Bonus based on performance Competitive salary Opportunity for advancement Training & development At ComForCare Home Care , we treat our team like family. We believe in celebrating wins, having fun, and working with purpose. If you're a fast learner,... 

Barclays

Model Validation AVP Job at Barclays

 ...Join us as a Model Validation AVP, where you will play a key role in independently reviewing and challenging models across financial crime, transaction monitoring, and market surveillance domains. You will assess model design, performance, data quality, and governance... 

StarLight Scholars Academy

Mini School Bus Driver (2025-2026 School Yr) NO CDL REQUIRED! Job at StarLight Scholars Academy

 ...Summary We are looking for a dependable, safety-focused, and professional School Bus Driver to become a valued member of our transportation team for the 20252026 academic year. The ideal candidate will demonstrate a strong commitment to student safety, exhibit punctuality...