Technical Writer; API

Purple Drive

Technical Writer (API)

Share Cleveland, OH

Overview:

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 Git Hub 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.