Technical Writer
New
J
JobgetherB2B SaaS
Based in IndiaFull-Time
Salary not disclosed
Apply NowOpens the employer's application page
Job Details
- Required Skills
- GitPostman
Requirements
- Have proven experience as a Technical Writer, preferably within a B2B SaaS company.
- Have strong expertise in documenting APIs, software products, and technical processes.
- Explain complex technical concepts in clear, accessible language.
- Have experience using version control systems such as Git to track changes and collaborate on documentation projects.
- Maintain documentation throughout the software development lifecycle.
- Demonstrate strong attention to detail and a commitment to accurate, consistent documentation.
- Collaborate effectively with developers, product managers, and technical subject matter experts.
- Docusaurus experience is an advantage.
- Practical experience with Markdown, YAML, and technical documentation tools is an advantage.
- Familiarity with API testing tools such as Postman is an advantage.
- Understanding of API design principles and documentation standards is an advantage.
- Ability to read and interpret code samples in Python, JavaScript, and Java is an advantage.
Responsibilities
- Develop structured, user-friendly API documentation using OpenAPI specifications.
- Manage and maintain API documentation using SwaggerHub.
- Gather technical information from developers and cross-functional teams and translate it into accessible documentation.
- Create, publish, and maintain knowledge base content using static site generators, preferably Docusaurus.
- Develop and update Markdown and YAML documentation for user guides, FAQs, and troubleshooting resources.
- Create and publish release notes covering features, enhancements, and bug fixes.
- Coordinate with product and development teams to gather information about upcoming releases.
- Create and maintain user manuals, installation guides, tutorials, and technical support materials.
- Review and improve documentation based on user feedback and product changes.
- Use version control and collaborative workflows to manage documentation updates.
View Full Description & ApplyYou'll be redirected to the employer's site