Setu API Technical Writer Interview: Rounds, Questions and Preparation

What the job involves

As a technical writer in Indian SaaS and B2B API companies, you create and maintain developer documentation such as API references, integration guides, tutorials, and SDK docs. You work closely with engineers, product managers, and customer support to translate complex technical concepts into clear, accurate content for developers. Day to day involves writing, reviewing code samples, testing endpoints, and updating docs based on product releases.

Role and Technical Knowledge

1. 1

   What is the difference between an API reference and an integration guide?

   Explain that API reference lists endpoints, parameters, and responses, while an integration guide walks through a use case step by step. Highlight how both serve different developer needs.

2. 2

   How would you document an authentication flow for a REST API?

   Cover API keys, OAuth, or JWT, and describe the sequence of steps a developer must follow. Mention including code samples in multiple languages and common error scenarios.

3. 3

   What is OpenAPI and why is it useful for technical writers?

   Describe OpenAPI as a specification for describing REST APIs. Explain that it enables auto-generated docs, consistency, and validation, reducing manual effort.

4. 4

   How do you ensure your documentation stays accurate as the API evolves?

   Talk about version control, docs-as-code, regular sync with engineers, and automated tests. Mention using changelogs and deprecation notices.

Practical Scenarios

1. 5

   A developer reports that your API documentation has a wrong parameter. How do you handle it?

   Show a systematic approach: verify the issue, check with the engineering team, update the docs, and add a test or review step to prevent recurrence. Mention communicating the fix to the developer.

2. 6

   You need to document a new webhook feature. What steps would you take?

   Outline understanding the feature, identifying the audience, drafting an overview, event types, payload examples, and security considerations. Include testing the webhook yourself.

3. 7

   How would you write a quickstart guide for a payments API?

   Focus on a minimal viable flow: sign up, get API keys, make a test payment, and handle responses. Emphasize clarity, copy-paste code, and common pitfalls.

4. 8

   You have to explain a complex concept like idempotency to a junior developer. How do you approach it?

   Use an analogy, define it simply, and show a practical example with code. Mention linking to further reading and avoiding jargon.

Behavioural and Collaboration

1. 9

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

   Use the STAR method. Highlight how you simplified without losing accuracy and checked for understanding.

2. 10

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

   Show openness to feedback, how you evaluated it, and what you changed. Emphasize growth and improved quality.

3. 11

   How do you prioritize documentation tasks when multiple product releases happen at once?

   Discuss impact on users, deadlines, and collaboration with product managers. Mention using a content calendar or backlog.

4. 12

   Give an example of a time you worked with engineers to get information you needed.

   Demonstrate proactive communication, respect for their time, and ability to ask precise questions. Mention following up and verifying details.

HR and Motivation

1. 13

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

   Connect your interest in technology and writing, and mention the impact of good docs on developer experience. Show you understand the company's product domain.

2. 14

   How do you stay updated with trends in API documentation and developer experience?

   Mention following blogs, communities like Write the Docs, and experimenting with tools. Show curiosity and continuous learning.

3. 15

   What do you think makes documentation successful for a B2B API product?

   Focus on accuracy, discoverability, and usability. Mention reducing support tickets and enabling self-service for developers.

4. 16

   Where do you see yourself in three years as a technical writer?

   Show ambition to deepen technical skills, maybe specialize in API docs or developer experience, and take on more complex projects. Align with company growth.