Software Technical writer

Role Overview

We are seeking a highly skilled Technical Writer with experience in creating structured documentation using DITA XML , developing clear API documentation , and working with tools like Swagger or Postman . The ideal candidate will collaborate with product managers, developers, and QA teams to deliver high-quality technical content that enhances the user experience.

Key Responsibilities

• Develop and maintain technical documentation, including user guides, API references, and developer documentation.
• Create structured content using DITA XML within a Component Content Management System (CCMS).
• Collaborate with engineering teams to understand product functionality and translate complex technical concepts into clear, user-friendly documentation.
• Write and maintain RESTful API documentation , including request/response examples, authentication details, and error codes.
• Use Swagger/OpenAPI specifications to document APIs and ensure accuracy.
• Validate API endpoints and workflows using Postman for testing and verification.
• Ensure documentation adheres to company standards, style guides, and best practices.
• Manage version control and updates for documentation in alignment with product releases.

Required Skills & Qualifications

• 6+ years of experience as a Technical Writer in a software or technology environment.
• Strong proficiency in DITA XML and experience with CCMS tools (e.g., SDL Tridion Docs, Oxygen XML Editor).
• Hands-on experience creating API documentation (REST, JSON, OpenAPI/Swagger).
• Familiarity with Swagger for API specification and Postman for API testing.
• Excellent written and verbal communication skills.
• Ability to work independently and manage multiple projects simultaneously.