API Technical Writer (5-10 yrs)

Job Description :

Responsibilities :

- Create and maintain comprehensive API documentation, including API reference guides, tutorials, code samples, and developer guides.

- Document RESTful APIs, GraphQL APIs, and other API types.

- Ensure documentation is accurate, up-to-date, and consistent with API changes.

- Develop and maintain API documentation using tools such as Swagger/OpenAPI, Markdown, or other documentation platforms.

- Work closely with developers, product managers, and QA engineers to gather information and ensure documentation accuracy.

- Participate in API design reviews and provide feedback on documentation requirements.

- Collaborate with developers to create code samples and examples.

- Develop and implement content strategies for API documentation.

- Plan and prioritize documentation tasks based on product release schedules and developer needs.

- Identify opportunities to improve documentation quality and usability.

- Ensure API documentation is user-friendly and accessible to developers of varying skill levels.

- Gather and incorporate developer feedback to improve documentation.

- Conduct usability testing and analyze user metrics to identify areas for improvement.

- Stay up-to-date with the latest API documentation tools and technologies.

- Utilize version control systems (e.g., Git) for documentation management.

- Develop and maintain documentation templates and style guides.

- Edit and proofread documentation for accuracy, clarity, and consistency.

- Ensure adherence to style guides and branding guidelines.

- Review and update existing documentation to reflect product changes.

Required Skills :

- Proven experience in creating and maintaining API documentation.

- Strong technical writing skills with the ability to explain complex concepts clearly and concisely.

- Understanding of RESTful APIs, GraphQL APIs, and other API technologies.

- Proficiency in using API documentation tools (Swagger/OpenAPI, Markdown, etc.).

- Experience with version control systems (Git).

- Excellent verbal and written communication skills.

- Ability to collaborate effectively with cross-functional teams.

- Strong problem-solving and analytical skills.

Required Experience :

- 5-10 years of experience as an API Technical Writer or similar role.

- Proven experience in documenting software APIs.

- Experience working in an Agile development environment.

- Experience with developer portals and knowledge bases.

Preferred Skills :

- Basic understanding of programming languages (e.g., Python, JavaScript).

- Experience with cloud platforms (AWS, Azure, GCP).

- Experience conducting usability testing and analyzing user metrics.

- Experience with content management systems.

- Knowledge of SEO best practices for technical documentation