Technical Writer

Rocketlane

Rocketlane

Marketing & Communications, IT
Chennai, Tamil Nadu, India
Posted on Jun 21, 2024

Overview

We are seeking an experienced technical writer specializing in B2B SaaS to create comprehensive help articles, troubleshooting guides, API documentation, and video scripts for new feature releases. The ideal candidate will have a strong technical background, excellent communication skills, and the ability to translate complex concepts into user-friendly content.

Responsibilities

1. Help Articles:

- Write detailed help articles to assist users in navigating and utilizing the software.

- Develop step-by-step guides, FAQs, and best practice documents.

- Update and maintain the knowledge base with the latest information.

2. Troubleshooting Guides:

- Create troubleshooting guides to help users resolve common issues.

- Develop flowcharts and decision trees for problem-solving.

- Collaborate with the support team to identify common user problems and document solutions.

3. API Documentation:

- Write and maintain comprehensive API documentation, including endpoint descriptions, request/response examples, and use cases.

- Create tutorials and sample codes to help developers integrate with our APIs.

- Ensure the documentation is up-to-date with the latest API changes and enhancements.

4. Video Scripts:

- Write clear and concise scripts for instructional videos and feature releases.

- Work with the video production team to ensure scripts are engaging and informative.

- Break down complex features into easy-to-understand segments for video content.

Qualifications

Technical Expertise:

- 1-3 years of proven experience in technical writing for B2B SaaS.

- Strong understanding of SaaS and APIs.

- Ability to grasp complex technical concepts and explain them in simple terms.

Writing Skills:

- Excellent written and verbal communication skills.

- Attention to detail and a knack for clear, concise writing.

- Experience in creating various types of technical documentation.

Good to have:

- Familiarity with API documentation tools such as Postman, or similar.

- Basic understanding of video production tools and software, such as Wistia, Loom, QuickTime

Key Competencies

Analytical Skills: Ability to analyze and organize help documentation using clear information hierarchy

Problem Solving: Skill in identifying user challenges and developing clear, step-by-step guides to address them.

Collaboration: Ability to work with cross-functional teams including developers, product managers, and support staff.

Adaptability: Comfortable working in a fast-paced environment with shifting priorities and deadlines.

Submit Your Application

You have successfully applied
  • You have errors in applying