Api technical writer
Anonymous · Bangalore g.p.o., India
Job Description
Hiring: API Technical Writer | Bangalore
We are looking for an experienced API Technical Writer to join our team
Location: CV Raman Nagar, Bangalore
Work Mode: 5 Days Work From Office
Experience: 4–7 Years
Role Overview
We 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 clear, accurate, and user-friendly documentation for both internal and external audiences.
Key Responsibilities
Create and maintain API reference documentation, including endpoints, parameters, sample code, responses, and error messages. Develop Getting Started guides, tutorials, how-to guides, FAQs, troubleshooting guides, and release notes. Document API workflows, integrations, business processes, and recommended usage patterns. Review existing documentation and identify gaps, outdated content, inconsistencies, and areas for improvement. Collaborate with developers, service owners, solution experts, and product teams to validate technical information. Create documentation for developer portals and API platforms. Develop diagrams, workflows, and visual aids to simplify technical concepts. Work with marketing teams to create technically accurate solution briefs and web content. Independently manage and prioritize the documentation backlog and drive content through review and publication.Required Skills
API Technical Writing / API Documentation
REST APIs / Web APIs
Swagger / Open API
JSON / XML
Postman or similar API tools
Developer Documentation / Developer Portals
Git/Git Hub and Confluence
Strong technical and formal English communication
Ability to work with developers and technical stakeholders
Ideal Candidate
A strong Technical Writer with proven API documentation experience, who can independently understand technical concepts, work with engineering teams, and produce high-quality developer-focused content.
Interested candidates can share their updated CV / profile.
#Hiring #Technical Writer #APITechnical Writer #APIDocumentation #RESTAPI #Swagger #Open API #Postman #Developer Documentation #Bangalore Jobs #Tech Jobs #Contract Jobs #Hiring Now
Details
| Company | Anonymous |
| Location | Bangalore g.p.o., India |
| Type | FULL TIME |
| Niche | tech |
| Experience | permanent |