Senior Technical Writer - Software Documentation

Placements24; East London; Hybrid; ZAR 420,000 - 640,000; Full time

Benefits offered by this job

Medical aid

Retirement planning

Professional development

Job summary

Placements24 is seeking a meticulous Senior Technical Writer to enhance documentation for software products in East London, South Africa. This role focuses on producing clear user guides, API references, tutorials, and online help content in collaboration with engineers and product managers.

The ideal candidate has 5+ years of technical writing experience, a strong portfolio, and the ability to translate complex technical information into accessible content while adhering to style guides and

Qualifications

• Bachelor's degree or equivalent practical experience in technical communication or related field.
• Minimum 5 years of experience as a Technical Writer in software.
• Experience writing for multiple audiences including developers and end users.

Responsibilities

• Write, edit, and maintain high-quality technical documentation (user manuals, API docs, SDK guides, release notes).
• Collaborate with SMEs (engineers, product managers) to gather information and ensure accuracy.
• Structure complex information for diverse audiences and maintain documentation standards.

Skills

Technical writing

Communication

Research skills

Education

Bachelor's degree in Technical Communication

Tools

MadCap Flare

Confluence

Git

Markdown

Job description

About the Role

Our client, a dynamic software development company, is seeking a meticulous and experienced Senior Technical Writer to enhance their documentation efforts in East London. This role is crucial for creating clear, concise, and accurate technical documentation for a range of software products, including user guides, API references, tutorials, and online help content. You will collaborate closely with product managers, engineers, and support teams to ensure documentation meets the needs of diverse audiences, from end-users to developers. The ideal candidate possesses exceptional writing skills, a keen understanding of software development processes, and the ability to translate complex technical information into accessible content. Join our client in East London and play a key part in improving user experience through superior documentation.

Key Responsibilities

• Write, edit, and maintain high-quality technical documentation, including user manuals, API documentation, SDK guides, release notes, and knowledge base articles.
• Collaborate with subject matter experts (SMEs), including engineers and product managers, to gather information and ensure technical accuracy.
• Organize and structure complex information logically and intuitively for various target audiences.
• Develop and manage documentation projects, ensuring timely delivery in alignment with product release schedules.
• Create and maintain documentation style guides and templates to ensure consistency across all materials.
• Review and edit documentation written by others for clarity, grammar, and technical accuracy.
• Gather feedback from users and internal stakeholders to continuously improve documentation quality.
• Stay updated on product developments and industry best practices in technical communication.
• Assist in the development of online help systems and interactive tutorials.

Requirements

• Bachelor's degree in Technical Communication, English, Computer Science, or a related field, or equivalent practical experience.
• Minimum of 5 years of experience as a Technical Writer, preferably in the software industry.
• Proven ability to write clear, concise, and accurate technical documentation for various audiences.
• Proficiency with documentation tools and technologies (e.g., MadCap Flare, Confluence, Git, Markdown).
• Strong understanding of software development lifecycles and methodologies.
• Experience documenting APIs and SDKs is highly desirable.
• Excellent research, interviewing, and organizational skills.
• Strong attention to detail and a commitment to quality.
• Ability to work independently and collaboratively in a team environment.
• Portfolio of technical writing samples.

Benefits

Our client offers a competitive salary, comprehensive benefits package including medical aid and retirement planning, and opportunities for professional development. This role is based in East London, offering a balanced work environment and the chance to contribute significantly to product usability. We value a collaborative culture and continuous improvement. Join our client and help shape how users understand and interact with our software from East London.