Technical Writer

Role & responsibilities

Technical Writer- Job Overview

Create and manage marketing and training documentation in line with ISG standards.

Develop user guides, API documentation, system architecture overviews, installation guides, release notes, troubleshooting articles, and FAQs.

Analyze FAQs and content to identify gaps and improvement areas.

Design document structures that enhance readability and visual appeal.

Collaborate with Subject Matter Experts (SMEs) to define content scope and ensure accuracy.

Communicate complex technical information effectively to diverse audiences.

Manage time effectively to meet project deadlines while delivering quality materials.

Adapt to feedback and adjust documentation as project objectives change.

Translate complex technical concepts into clear documentation, including API specs and SDK guides.

Produce detailed technical specifications and system design documents.

Engage in Agile workflows, contributing to iterative processes and ensuring timely documentation delivery.

Documentation for our SaaS products, including user guides, Technical/System Architecture, API documentation, installation guides, Entity Relationship Diagrams, release notes, troubleshooting articles, and FAQs.

Code Documentation: Document code libraries and software components, focusing on function definitions, method usage, and configuration

Preferred candidate profile

Requirements:

Bachelors degree in a related technical discipline or a combination of education, technical certifications, and relevant work experience.

A minimum of 5-7 years of experience in designing and delivering marketing and training documentation in a technical environment.

Proficiency in creating effective storyboards and possessing strong graphic design skills.

Thorough understanding of software-driven business processes and experience with the Software Development Life Cycle (SDLC).

Excellent time management skills, with the ability to work independently and collaboratively with SMEs in a remote setting.

Knowledge of instructional design principles and technologies is preferred.

Familiarity with SaaS products and experience in documenting REST APIs, including an understanding of technical details such as authentication methods, endpoints, and response formats.

Interested can directly share their updated resume to (makeenahmed@tentacletech.com)