Technical Writer

We are looking for a Technical Writer for building an API Developer Portal

The candidate would be responsible for developing and executing a content strategy specifically focused on an API developer portal, crafting clear, concise, and informative documentation, tutorials, guides, and reference materials to enable developers to effectively utilize the company's APIs, while aligning content with overall business goals and target audience needs; this includes researching developer needs, creating engaging content formats, and ensuring the portal is user-friendly and well-organized for optimal developer experience.

Key Responsibilities:

Content Planning and Development:

• Define content strategy for the API developer portal, including key documentation types (API reference guides, quick start tutorials, best practices, troubleshooting guides, etc.).

• Research and understand target developer audience needs and technical skill levels to tailor content accordingly.

• Create detailed content outlines and editorial calendars for consistent content delivery.

• Develop and maintain style guides to ensure consistency in tone, terminology, and formatting across the portal.

Content Optimization and Maintenance:

• Monitor usage analytics to identify areas for improvement and update content based on developer feedback.

• Ensure content remains accurate and up-to-date with API changes and new features.

• Optimize content for search engine visibility and discoverability.

• Collaboration and Stakeholder Management:

• Work closely with API development teams to understand technical details and gather necessary information for documentation.

• Collaborate with product marketing and design teams to ensure content aligns with overall brand messaging and user experience.

• Contribute to the development of developer portal features and functionality based on user feedback.

Required Skills and Qualifications:

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

• Understanding of API design principles, RESTful architecture, and common API protocols.

• Experience with API documentation tools and platforms (e.g., Swagger, OpenAPI, Postman)

• Excellent communication and collaboration skills to work with cross-functional teams

• Familiarity with content management systems (CMS) and SEO best practices

• A strong passion for developer experience and a desire to create user-friendly documentation