Apply on Employer Site

VARITE INC · 5 hours ago

Technical Writer (API)

Cleveland, OH

Full-time

Onsite

Mid, Senior Level

$53.57/hr - $55.14/hr

3+ years exp

VARITE INC is an award-winning minority business enterprise providing global consulting and staffing services. They are seeking a Technical Writer (API) to create and maintain API documentation, collaborate with developers and product managers, and ensure accuracy in technical content.

Information Technology & Services

Growth Opportunities

Responsibilities

Create API Documentation: Write API reference documentation, conceptual guides, tutorials, and tutorials

Document Structure: Detail API functions, parameters, data structures, authentication methods, and error messages

Maintain Content: Regularly update documentation to reflect new features, changes, and API versioning

Collaborate: Partner with developers, product managers, and engineers to understand functionality and ensure accuracy

Use Documentation Tools: Utilize tools like Swagger/OpenAPI, Postman, and Git-based systems (GitHub/GitLab) to generate or publish content

Gather Feedback: Collect feedback from internal teams and external developers to improve usability

Technical Proficiency: Strong understanding of RESTful APIs, JSON, and at least one or two programming languages

Writing Skills: Excellent, clear, and concise writing, with the ability to explain complex technical concepts simply

Qualification

API DocumentationRESTful APIsDocumentation ToolsGithub EnterpriseCollaborationCommunicationWriting Skills

Required

Generally 3-5+ years in technical writing, often requiring prior experience in API-specific documentation

Application Programming Interface (API)

Collaboration

Business Domain Strategic Research and Writing

Github Enterprise

Communication

Documentation Review & Editing