Job Description
???? Hiring: API Technical Writer | Bangalore
nWe are looking for an experienced API Technical Writer to join our team
nLocation: CV Raman Nagar, Bangalore
nWork Mode: 5 Days Work From Office
nExperience: 4–7 Years
nRole Overview
nWe are seeking a skilled API Technical Writer with strong technical English and hands-on experience creating API and developer documentation . The ideal candidate should be able to understand complex technical concepts and translate them into transparent, accurate, and user-friendly documentation for both internal and external audiences.
nKey Responsibilities
n• Create and maintain API reference documentation , including endpoints, parameters, sample code, responses, and error messages.
n• Develop Getting Started guides, tutorials, how-to guides, FAQs, troubleshooting guides, and release notes .
n• Document API workflows, integrations, business processes, and recommended usage patterns.
n• Review existing documentation and identify gaps, outdated content, inconsistencies, and areas for improvement.
n• Collaborate with developers,
service owners, solution experts, and product teams to validate technical information.
n• Create documentation for developer portals and API platforms .
n• Develop diagrams, workflows, and visual aids to simplify technical concepts.
n• Work with marketing teams to create technically accurate solution briefs and web content .
n• Independently manage and prioritize the documentation backlog and drive content through review and publication.
nRequired Skills
n✅ API Technical Writing / API Documentation
n✅ REST APIs / Web APIs
n✅ Swagger / OpenAPI
n✅ JSON / XML
n✅ Postman or similar API tools
n✅ Developer Documentation / Developer Portals
n✅ Git/GitHub and Confluence
n✅ Strong technical and formal English communication
n✅ Ability to work with developers and technical stakeholders
nIdeal Candidate
nA strong Technical Writer with proven API documentation experience , who can independ
📌 API Technical Writer (Bengaluru)
🏢 UST
📍 Bengaluru