Description

You will own the creation and maintenance of technical documentation focused on APIs.

Responsibilities

• Create and maintain API documentation, including reference guides, developer guides, tutorials, and sample code examples.
• Collaborate with development and product teams to gather specifications and understand API functionality.
• Organize and structure API documentation to ensure easy navigation and keep it current with releases.
• Evaluate API design and provide feedback to improve clarity, consistency, and usability of interfaces.
• Develop and maintain code samples and use cases demonstrating proper API integration.

Required Skills

• 5+ years of proven experience as a Technical Writer with a focus on API documentation.
• Strong understanding of APIs and RESTful Web Services.
• Proficiency in writing clear, concise, and well-structured technical documentation.
• Familiarity with API documentation tools such as Swagger/OpenAPI or Postman.
• Experience with markup languages like Markdown and version control systems like Git.
• Exposure to coding languages, including Python and Javascript.
• Bachelor's degree in Technical Communication or Computer Science.

Key Skills

Education

Bachelor's degree in Technical Communication, Computer Science