HamburgerMenu
hirist

Technical Writer - API Documentation

SentientGeeks
Kolkata
2 - 3 Years
star-icon
4.3white-divider75+ Reviews

Posted on: 20/08/2025

Job Description

Roles and Responsibilities :


1. The position will be responsible for authoring and maintaining :

- Installation and Deployment Guides

- Operations Manuals

- Application and UI User Manuals

- API Reference Manuals

- Training Manuals

- Online Help and Context Sensitive Help

- Associated graphics

2. May additionally assist in creating marketing collateral and RFPs.

3. The position requires excellent communication & interpersonal skills.

4. The candidate will need to possess excellent language and editorial skills, and proven past experience in a similar position.

5. Language skills will be the benchmark for hiring.


Experience :

- Mandatory : 2 to 3 years of relevant experience, especially using industry standards and tools such as AsciiDoc, Adobe RoboHelp, Arbortext Editor, Oxygen.


Skills :


- Demonstrable expertise in creating, editing, and publishing technical and user documentation.

- Excellent skills in communication, research, organization, collaboration, and teamwork.

- A good grasp of technical terminology combined with the ability to write in a simple, concise, and accurate manner.


Technical Competencies :


Mandatory :


- Expertise in authoring using help authoring tools such as AsciiDoc, Adobe RoboHelp, Arbortext Editor, Oxygen.

- Proficiency in MS Office Suite, Adobe Acrobat Pro, and photo editing tools such as Adobe Photoshop.

- Experience in writing API manuals.


Specialization Description :


- Technical Writing & Editing work focuses on writing documentation for technical products, systems, processes, equipment operations & maintenance, research findings, etc. for internal or external audiences, including :

- Determining an effective structure and layout for complex manuals and other technical documentation.

- Conducting research and liaising with technical staff to ensure accurate interpretation of complex technical data, drawings, and specifications.

- Ensuring that appropriate technical content and terminology review occurs and that provision is made for the incorporation of updates and revisions.

- Editing content to improve clarity, impact, flow, meaning, and readability.


Level Description :


- Experienced level professional that applies practical knowledge of job area typically obtained through advanced education and

work experience.

- Works independently with general supervision.

- Works to achieve operational targets within the job area with a direct impact on function/sub-function results.

- Problems faced are difficult but typically not complex.

- May influence others within the job area through explanation of facts, policies, and practices


info-icon

Did you find something suspicious?