Freshservice Technical Writer Interview: Rounds, Questions and Preparation

What the job involves

As a technical writer in Indian SaaS and B2B products, you create and maintain user guides, API documentation, release notes, and help articles for software used by businesses. You work closely with product managers, engineers, and support teams to translate complex features into clear, accurate content for administrators and end-users. The role demands strong writing, editing, and information-design skills, plus a working understanding of how SaaS products are built and delivered.

Role and Technical Knowledge

1. 1

   What is the difference between a user guide and an API reference, and when would you use each?

   Explain that user guides are task-oriented for end-users, while API references are for developers and list endpoints, parameters, and examples. Mention that both serve different audiences and purposes.

2. 2

   How would you document a new feature in a SaaS product like Freshservice?

   Outline steps: gather requirements from product managers, test the feature, write a draft, get reviews from engineers and support, and publish with screenshots or videos. Emphasize accuracy and user perspective.

3. 3

   What is structured authoring, and why is it useful for SaaS documentation?

   Structured authoring uses XML/DITA to separate content from formatting, enabling reuse and consistency. It helps manage large doc sets and multiple output formats like web and PDF.

4. 4

   What are some key elements of a good release note?

   Cover what changed, why it matters, who is affected, and any action required. Keep it concise, use plain language, and link to detailed docs if needed.

Practical Scenarios

1. 5

   You have to document a complex API with no existing documentation. How do you start?

   Talk to developers, review code or Swagger files, test endpoints using Postman, and create a skeleton with authentication, endpoints, and examples. Iterate with feedback.

2. 6

   A product manager asks you to document a feature that is not yet finalized. What do you do?

   Clarify the scope and timeline, request a draft spec, and write a preliminary version marked as draft. Set up a review cycle to update as the feature evolves.

3. 7

   How would you handle conflicting information from two engineers about how a feature works?

   Verify by testing the feature yourself or checking with a third source like QA. Document the correct behavior and inform both engineers to align understanding.

4. 8

   You need to update documentation for a UI change across 50 help articles. How do you manage it?

   Use search and replace carefully, prioritize high-traffic articles, and use a checklist or script to track progress. Consider content reuse or variables to avoid future manual updates.

Behavioural and HR

1. 9

   Tell me about a time you had to explain something technical to a non-technical person.

   Use the STAR method: describe the situation, your approach to simplify, and the positive outcome. Highlight empathy and clarity.

2. 10

   How do you handle tight deadlines when multiple documentation requests come at once?

   Explain how you prioritize based on impact and deadlines, communicate with stakeholders, and manage time. Mention tools like Trello or Jira for tracking.

3. 11

   Why do you want to work as a technical writer in a SaaS company?

   Show enthusiasm for simplifying complex software, interest in technology, and desire to help users. Connect to the company's product and mission.

4. 12

   Describe a time you received critical feedback on your writing. How did you respond?

   Show openness to feedback, how you incorporated it, and what you learned. Emphasize continuous improvement and collaboration.

Tools and Process

1. 13

   What documentation tools have you used, and how do you choose the right one?

   Mention tools like MadCap Flare, Adobe FrameMaker, Confluence, or static site generators. Explain that choice depends on team needs, output formats, and collaboration requirements.

2. 14

   How do you ensure consistency across a large documentation set?

   Use a style guide, templates, and terminology database. Conduct peer reviews and use automated checks like linters for grammar and style.

3. 15

   What is docs-as-code, and what are its benefits?

   Docs-as-code treats documentation like software: stored in version control, written in plain text, and built automatically. Benefits include collaboration, versioning, and faster updates.

4. 16

   How would you measure the success of your documentation?

   Use metrics like page views, search success rate, support ticket reduction, and user feedback. Tie metrics to business goals like reducing support calls.