Technical Documentation Writer

Shashwath Solution; Pune District; On-site; INR 450,000 - 750,000; Full time

Job summary

Shashwath Solution is seeking a Technical Documentation Writer to craft clear, concise manuals, guides, and online help for our SaaS products. You will collaborate with product managers, developers, and stakeholders to translate complex concepts into accessible documentation.

You will create visuals, maintain up-to-date content, and ensure adherence to style guides. A bachelor’s degree in a related field and experience with MadCap Flare or FrameMaker are preferred.

Qualifications

• Proven experience as a Technical Writer in software/SaaS is required.
• Excellent written and verbal communication skills.
• Ability to translate complex technical concepts into clear guides and manuals.
• Strong attention to detail and organizational skills.
• Experience with documentation tools like MadCap Flare, FrameMaker, MS Word.
• Familiarity with Markdown, HTML, and web-based docs.
• Ability to work independently and manage multiple docs.
• Bachelor's degree in a related field preferred.

Responsibilities

• Develop, write, and maintain user guides, installation manuals, API docs, FAQs, and online help.
• Collaborate with product managers and developers to understand functionality and use cases.
• Create visuals like diagrams, screenshots, and videos for docs.
• Update docs to reflect product changes and feedback; ensure consistency with style guides.
• Review content from others for accuracy and completeness.
• Assist in creating training materials and other docs as needed.

Skills

Technical Writing

Documentation Tools

Markdown

HTML

Adobe FrameMaker

MadCap Flare

MS Word

Communication Skills

Attention to detail

Project Management

Education

Bachelor's degree in Technical Writing/Communications/CS

Tools

MadCap Flare

Adobe FrameMaker

Markdown

HTML

Microsoft Word

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.