Qualis1 Inc. · 11 hours ago
Technical Writer
Cleveland, OH
Contract
Onsite
Senior Level
6+ years expQualis1 Inc. is seeking a Technical Writer to create and maintain API documentation. The role involves collaborating with developers and product managers to ensure accuracy and usability of the documentation.
Staffing & Recruiting
Hiring Manager
Salman (Vicky Sharma)
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
Required
Experience 6-10 Years
Skills: Digital : Application Programming Interface (API), Collaboration, Business Domain Strategic Research and Writing, Github Enterprise, Communication, Documentation Review & Editing
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
Experience Level: Generally 3-5+ years in technical writing, often requiring prior experience in API-specific documentation
Company
Qualis1 Inc.
At Qualis1 Inc., our robust business model is strategically built upon serving diverse industry sectors, including Finance, Health Care, Education, State Government, and Manufacturing.
51-200 employees
Funding
Current Stage
Growth StageCompany data provided by crunchbase