Our clients reserves the right not to make an appointment. In considering candidates for appointment into advertised posts, preference will be accorded to persons from a designated group in accordance with the approved Employment Equity Plan.
Technical Writer
(Technical Writer)
Overview
Reference
Technical Writer
Salary
ZAR/month
Job Location
- South Africa -- City of Cape Town -- Cape Town
Job Type
Permanent
Posted
16 September 2024
Our client is looking for a highly skilled and detail-oriented Technical Writer to join their team. The ideal candidate will be responsible for creating clear and concise documentation that helps users understand complex products and services. The role involves collaborating with product teams and subject matter experts to ensure all technical information is presented in an accessible manner to both technical and non-technical audiences.
Responsibilities:
- Create and maintain solution guides for products and services, covering multiple components that provide solutions for payment and digital product transactions.
- Collaborate with product teams to understand how different components work together to create a unified solution.
- Develop and maintain guides for external integrators/developers using internally developed APIs.
- Research and gather information from various sources to compile accurate and user-friendly documentation.
- Provide editing support for all technical documents as needed.
- Maintain a well-organized document library with a relevant taxonomy.
- Measure the effectiveness of documentation through user interaction and feedback.
- Develop documentation standards and communicate complex concepts in a concise, audience-friendly manner.
- Collaborate with product teams on product development and launches to ensure documentation is up-to-date.
Key Skills:
- Strong written and verbal communication skills.
- Excellent interpersonal skills, including interviewing and active listening.
- Proficient research and analytical skills with great attention to detail.
- Ability to work on multiple projects and meet tight deadlines.
- Proficiency in creating diagrams to convey technical concepts.
- Ability to translate complex technical information into clear, easy-to-understand documentation for non-technical readers.
- 5+ years of experience in writing technical documentation for software products.
- Proficiency in Microsoft Office, OpenAPI Specification 3, Markdown, and Git.
Qualifications:
- Relevant Bachelor’s degree or similar qualification is advantageous but not essential.
|