Back to search
An exciting opportunity has arisen for an experienced API Technical Writer to join a dynamic fintech company at the forefront of digital payments innovation. This role offers the chance to work on cutting-edge technology, shaping the developer experience through clear, engaging, and impactful documentation. As part of a global team, the successful candidate will play a crucial role in helping users unlock the full potential of the company's API solutions.
Responsibilities:
-
Produce detailed API documentation for the developer portal.
-
Develop instruction manuals, how-to guides, and technical articles explaining API features and use cases.
-
Write user manuals, software installation guides, and operating procedures.
-
Document API endpoints, including code samples and error messages.
-
Create diagrams and visuals to illustrate API functionality and integration.
-
Collaborate with developers and product teams to ensure accuracy and clarity.
-
Optionally, contribute to service level agreements, case studies, and white papers.
Key Deliverables:
-
Comprehensive API documentation integrated into the developer portal.
-
Instructional and support content guiding users through API usage.
-
Visual diagrams explaining API architecture and integration.
-
Well-structured user manuals and installation guides.
-
Additional optional materials such as SLAs and case studies.
Requirements:
-
Strong writing and communication skills with the ability to explain complex technical concepts clearly.
-
Technical expertise in APIs, including RESTful APIs, endpoints, HTTP methods, and error handling.
-
Research and audience analysis skills to tailor content to different users.
-
Editing and proofreading proficiency to ensure clarity and consistency.
-
Experience with documentation tools such as Markdown, Confluence, and GitHub.
-
Prior experience in technical writing, particularly in API documentation.
-
A relevant degree (Technical Writing, Communications, Computer Science) is beneficial but not required
At Gleeson Recruitment Group, we embrace inclusivity and welcome applicants of all backgrounds, experiences, and abilities. We are proud to be a disability confident employer.By applying you will be registered as a candidate with Gleeson Recruitment Limited. Our Privacy Policy is available on our website and explains how we will use your data.
