Technical Documentation Writer

Shashwath Solution; Dadri; On-site; INR 500,000 - 900,000; Full time

Job summary

Shashwath Solution is seeking a Technical Documentation Writer to create clear guides, manuals, API docs, and online help for customers and internal teams. You will collaborate with product managers and developers to translate complex features into accessible content.

You will also produce diagrams, screenshots, and videos, maintain documentation, ensure consistency with style guides, and review content from peers to ensure accuracy.

Qualifications

• Proven experience as a Technical Writer in software or SaaS
• Excellent written and verbal communication skills
• Ability to explain complex technical concepts clearly
• Strong attention to detail and organization
• Experience with MadCap Flare, FrameMaker or similar tools
• Familiarity with Markdown, HTML, and web formats
• Ability to manage multiple projects independently
• Bachelor's degree preferred in related fields

Responsibilities

• Develop, write, and maintain high-quality technical documentation: user guides, installation manuals, API docs, FAQs, online help
• Collaborate with product managers, developers, and stakeholders to gather information and understand product features
• Create diagrams, screenshots, and videos to enhance documentation
• Update documentation to reflect product updates and user feedback; ensure consistency with style guides
• Review and edit content for accuracy and completeness
• Assist in creating training materials and other documentation-related tasks

Skills

Swagger

Git

Agile

SaaS

Technical writing

API documentation

Documentation tools

Dita

XML

Jira

Confluence

FrameMaker

MadCap Flare

HTML

Postman

Markdown

Snagit

RoboHelp

Education

Bachelor's degree in Technical Writing, Communications, Computer Science, or a related field

Tools

MadCap Flare

Adobe FrameMaker

Microsoft Word

Markdown

HTML

Postman

Job description

As a Technical Documentation Writer, you will play a critical role in ensuring our customers and internal teams have access to clear, concise, and accurate documentation. You will work closely with product managers, developers, and other stakeholders to understand our products and translate complex technical information into easy-to-understand guides, manuals, and online help resources.

Responsibilities

• Develop, write, and maintain high-quality technical documentation, including user guides, installation manuals, API documentation, FAQs and online help.
• Collaborate with product managers, developers and other stakeholders to gather information and understand the functionality and use cases of our products.
• Create visual aids such as diagrams, screenshots and videos to enhance the documentation.
• Continuously update documentation to reflect product updates, new features, and customer feedback. Ensure consistency and adherence to style guides and documentation standards.
• Review and edit content created by other team members for accuracy, clarity and completeness.
• Assist in the creation of training materials and other documentation-related tasks as needed.

Requirements

• Proven experience as a Technical Writer, preferably in the software or SaaS industry.
• Excellent written and verbal communication skills.
• Ability to understand and explain complex technical concepts in a clear and concise manner.
• Strong attention to detail and organizational skills.
• Experience with documentation tools such as MadCap Flare, Adobe FrameMaker, Microsoft Word or similar.
• Familiarity with Markdown, HTML, and other web-based documentation formats.
• Ability to work independently and manage multiple projects simultaneously.
• Basic understanding of software development processes and SaaS products.
• Bachelor's degree in Technical Writing, Communications, Computer Science, or a related field is preferred.

Preferred Qualifications

• Experience with API documentation and tools like Swagger or Postman.
• Knowledge of version control systems like Git.
• Familiarity with Agile development methodologies.
• Experience creating video tutorials or other multimedia content.
• Opportunity to work with a dynamic and innovative team.
• Professional development and growth opportunities.

SaaS, MadCap Flare, Adobe FrameMaker, Microsoft Word, Markdown, HTML, and other web-based documentation formats, software development processes, API documentation and tools like Swagger or Postman, version control systems like Git, Agile development methodologies, video tutorials or other multimedia content, user guides, installation manuals, API documentation, FAQs and online help, visual aids such as diagrams, screenshots and videos to enhance the documentation, creation of training materials and other documentation-related tasks.

Mandatory Key Skills

swagger,git,agile,saas,technical writing,api documentation,technical documentation,documentation tools,user support,documentation,dita,xml,snagit,robohelp,jira,content writing,confluence,framemaker*,api*,madcap flare*,html*,postman*