ROLE PURPOSE

• API Technical Writer leads the creation and maintenance of high-quality API documentation and developer resources. He/she works closely with product managers and developers to ensure our API documentation is clear, accurate, and helpful to external and internal users. The role owner shall maintain a passion for simplifying complex technical concepts for a diverse developer audience.

Responsibilities (DUTIES) 

• Maintain Up-to-Date API Documentation: Continuously review and update API reference documentation, ensuring it reflects the latest functionality, use cases, and versioning. 
• Manage and Enhance the API Developer Portal: Administer the developer portal to ensure all technical content, guides, and resources are current. Devise and implement innovative ways to enhance the overall developer experience. 
• Customer Communication: Communicate with customers on new releases, deprecation notices, and API migration plans, ensuring a smooth and transparent adoption process. 
• Release Notes Management: Prepare and publish detailed release notes for new API versions, feature enhancements, bug fixes, and deprecations. 
• Engage in Developer Support Forums: Monitor, respond to, and escalate developer queries across community forums, contributing to a positive developer experience. 
• API Product Documentation & Catalog: Create and manage comprehensive API product documentation, including product overviews, architecture diagrams, integration workflows, and catalogs. 
• User Guides & Quick References: Write and maintain user-centric guides and quick reference materials to assist developers in adopting and integrating APIs effectively. 
• Create Tutorials, FAQs, and Walkthroughs: Develop step-by-step tutorials, code samples, FAQ sections, and walkthroughs tailored to different developer personas. 
• Collaborate with Cross-Functional Teams: Work closely with engineering, product, QA, and support teams to gather technical details and ensure documentation accuracy

Qualifications
Experience: 

• Minimum of 3 years hands-on development experience in a software engineering, backend/API development, or technical writing role. 
• Proven experience documenting RESTful APIs, SDKs, and developer tools. 

Education: 

• Bachelor’s degree in computer science, Information Technology, Engineering, Technical Communication, or a related field. 

Technical Skills: 

• Proficiency in API documentation tools such as Swagger/OpenAPI, Postman, or Redoc. 
• Ability to read and understand programming languages such as JavaScript, Python, Java, or similar. 

 Soft Skills: 

• Excellent written and verbal communication skills. 
• Strong attention to detail and a user-focused mindset. 
• Ability to manage multiple documentation projects and meet deadlines. 
• Preferred Qualifications: 
• Exposure to CI/CD processes and API lifecycle management tools. 
• Familiarity with agile methodologies and product lifecycle documentation.