Technical Writer

API Technical Writer

Job Description:

We are looking for an experienced and skilled API Technical Writer to join our team. The primary responsibility of this role is to create clear, comprehensive, and user-friendly documentation that explains how our Application Programming Interface (API) functions. The ideal candidate will help new and existing users understand the features, use cases, and best practices of the API, guiding them through implementation and usage to achieve their goals.

Responsibilities:

• Create clear and detailed API documentation for the developer portal (must-have skill set)
• Develop instruction manuals, how-to guides, and journal articles explaining API features and use cases
• Write user manuals, software installation guides, and standard operating procedures
• Provide detailed descriptions of API endpoints, including code samples and error messages
• Create diagrams and visuals to help users understand how the product works and how to integrate the API
• Collaborate with developers, product teams, and other stakeholders to gather information and ensure the documentation is accurate and up-to-date
• Develop service level agreements, case studies, and white papers (nice to have skill set, but not essential)

Deliverables:

• Comprehensive API documentation available as part of the developer portal experience
• Instructional and support content to guide users through the API and help them achieve their goals
• Visual diagrams illustrating API architecture and usage
• Well-written user manuals, installation guides, and operating procedures
• Additional materials such as service level agreements, case studies, and white papers (optional)

Key Skills Required:

• Strong writing and communication skills, with the ability to break down complex technical concepts for various audiences
• Technical expertise, with the ability to understand and explain APIs in a clear and accessible manner
• Research skills to gather technical details and understand how the API works
• Audience analysis skills to tailor documentation to developers, product managers, and other users
• Excellent editing and proofreading skills to ensure clarity, accuracy, and consistency
• Design skills for creating visual content (diagrams, flowcharts) to complement the written documentation
• Strong collaboration skills to work effectively with cross-functional teams (developers, product managers, etc.)

Qualifications:

• Proven experience in technical writing, specifically related to API documentation
• Familiarity with API concepts, including RESTful APIs, endpoints, HTTP methods, and error handling
• Experience with developer portals and content management systems (CMS)
• Proficiency in documentation tools (e.g., Markdown, Confluence, GitHub)
• A degree in Technical Writing, Communications, Computer Science, or a related field is a plus, but not required

If you are passionate about making technical concepts easy to understand and enjoy working collaboratively with technical teams, please apply to David Eales with an up to date CV.