SUMMARY:
Develop and maintain clear, concise, and accurate product documentation.
POSITION INFO:
Role Overview:
The purpose of this role is to develop and maintain clear, concise, and accurate product documentation that helps users understand and effectively use the product; as well as to ensure completeness of required product record-keeping. This includes release notes, user manuals, specific guides, tutorials, FAQs, and other instructional materials.
Location:
• Hybrid – Cape Town / Johannesburg
Qualifications and Experience:
• Matric / National Senior Certificate (NSC) / GCSE / Equivalent
• Technical writing certification or course
• Minimum of 3-5 years’ experience in software development environment
Key Responsibilities:
• Create and maintain product launch documentation.
• Create and maintain user documentation that is complete, clear and user-centred.
• Continuously improve documentation value through ongoing updates and innovation.
• The documentation is intended to help users achieve a goal through the quick and efficient transfer of information.
• Collaborate with development teams to gather information on software products and services
• Respond to customer inquiries related to technical documentation
• Continuous Learning: Since technology is constantly evolving, a Technical Writer is expected to stay updated with latest documentation trends and relevant technology related to documentation tools as well as to the products for which they are writing.
Critical Technical and Behavioural Skills Required:
• Working knowledge of Hyper automation products (or an equivalent LCAP) at Developer level - this includes being comfortable with the software objects and applications within the Platform, hardware devices used with it, and other technical tools relevant to the product as they are added.
• A background in software development is preferred.
• Attention to Detail: Technical documentation requires accuracy and precision. Paying attention to details ensures that the information provided is correct and consistent.
• Analytical Thinking: The ability to analyze complex technical information and distill it into clear, understandable content for users is essential. This includes understanding the product functionality and its implications for users.
• Problem-Solving Skills: Technical writers often encounter challenges such as unclear information or complex concepts. Being able to research, analyze, and find solutions to these challenges is key.
• Adaptability: Products and technologies evolve rapidly. Technical writers need to adapt to changes, new features, and updates quickly, while also adjusting their documentation accordingly.
• Collaboration and Teamwork: The Technical Writer works closely with subject matter experts, developers, designers, and other stakeholders. Strong collaboration skills help in gathering information, validating content, and ensuring documentation meets the needs of all stakeholders.
• Time Management and Prioritization: Managing multiple projects and deadlines is common for technical writers. Effective time management and the ability to prioritize tasks ensure that documentation projects are completed on schedule.
• Empathy and User Advocacy: Understanding the perspective of the end-users and advocating for their needs in the documentation is important. Empathy helps in creating documentation that is user- friendly and addresses common user challenges.
• Clear Communication: Beyond writing skills, clear verbal communication is important for discussing requirements, gathering information, and collaborating with team members.
• Professionalism and Ethics: Upholding professional standards in communication, respecting confidentiality, and maintaining ethical conduct in handling sensitive information are essential traits for technical writers.
