Technical Writer (Software Engineering Team) at Interswitch

About the job

• We are seeking a highly skilled Technical Writer to join our software engineering team.
• The ideal candidate will be responsible for creating, maintaining, and improving technical documentation that enables developers, engineers, and end-users to understand and effectively use our software products.
• You will collaborate closely with software engineers, product managers, and QA teams to ensure that all technical content is accurate, clear, and user-friendly.

Key Responsibilities
Documentation Development:

• Write, edit, and maintain technical documentation, including:
• API references
• SDK and library documentation
• Developer guides
• System architecture documents
• User manuals and quick start guides
• Create internal documentation for engineering processes, workflows, and best practices.

Collaboration:

• Work closely with software engineers to understand new features, system architecture, and technical details.
• Partner with product managers to align documentation with product requirements and release notes.
• Collaborate with QA to document known issues, troubleshooting steps, and testing workflows.

Content Strategy & Standards:

• Establish and enforce documentation standards, templates, and style guides.
• Ensure consistency, clarity, and accuracy across all technical documentation.
• Advocate for documentation best practices within the engineering team.

Tools & Processes:

• Use modern documentation tools (e.g., Markdown, Sphinx, Docusaurus, Git-based workflows, Confluence, Jira).
• Maintain documentation in sync with code using version control (e.g., GitHub/GitLab).
• Implement automation where possible (e.g., auto-generating API docs from code annotations).

Knowledge Sharing:

• Organize and maintain internal knowledge bases and wikis.
• Assist engineers in documenting design decisions and technical debt.
• Provide documentation support during onboarding of new engineers.

Qualifications
Education & Experience:

• Bachelor’s degree in Computer Science, Engineering, Technical Communication, or related field (or equivalent practical experience).
• 3+ years of experience as a Technical Writer in a software engineering environment or equivalent

Technical Skills:

• Strong understanding of software development concepts, SDLC, Agile, and CI/CD pipelines.
• Ability to read and understand at least one programming language (Java, c#, Go, or JavaScript).
• Familiarity with APIs (REST, GraphQL) and cloud technologies.
• Experience with documentation frameworks (Sphinx, MkDocs, Docusaurus, Swagger/OpenAPI).

Soft Skills:

• Excellent written and verbal communication skills.
• Strong attention to detail and ability to simplify complex concepts.
• Collaborative mindset and ability to work closely with engineers in an agile environment.

Preferred Qualifications:

• Experience documenting distributed systems, microservices, or developer tools.
• Knowledge of containerization and orchestration (Docker, Kubernetes).
• Familiarity with UX writing for developer portals or CLI tools.
• Prior experience contributing to open-source documentation.