13 Aug
|
Inswit
|
Chennai
Key Responsibilities
- Create and maintain comprehensive API documentation, including REST APIs, authentication, request/response examples, error codes, and SDK documentation.
- Perform API testing using Postman to validate API functionality and ensure documentation accuracy.
- Develop and maintain Product Documentation, including feature documentation, administrator guides, installation guides, and configuration manuals.
- Create User Documentation, including user manuals, quick start guides, online help, FAQs, and knowledge base articles.
- Prepare and publish Release Notes for every product release, highlighting new features, enhancements, bug fixes, known issues, and upgrade instructions.
- Author and manage documentation using MadCap Flare, ensuring consistency, version control, and high-quality outputs across multiple formats.
- Collaborate with Product Managers, Developers, QA Engineers, Customer Success, and Support teams to gather technical information and document new features.
- Develop troubleshooting guides, implementation guides, and customer support documentation.
- Review, edit, and update documentation to reflect product enhancements and changes.
- Create and maintain internal technical documentation, SOPs, and process documents.
- Ensure all documentation follows the organization's documentation standards, templates, and style guidelines.
Required Skills
- 3 to 6 years of experience as a Technical Writer in a product-based software or SaaS company.
- Solid technical writing, editing, and proofreading skills.
- Hands-on experience with MadCap Flare for authoring, publishing, and maintaining technical documentation.
- Experience creating and maintaining API documentation using Swagger/OpenAPI, Postman, or similar tools.
- Hands-on experience with Postman for API testing, validation, and documentation.
- Good understanding of REST APIs, JSON, XML, HTTP methods, OAuth, and API authentication.
- Experience with documentation tools such as MadCap Flare, Confluence, Markdown, Git, Swagger/OpenAPI, Postman, and Microsoft Office.
- Familiarity with version control systems such as Git.
- Understanding of the Software Development Life Cycle (SDLC) and Agile/Scrum methodologies.
- Excellent written and verbal communication skills with the ability to simplify complex technical concepts for technical and non-technical audiences.
- Strong analytical, organizational, and stakeholder management skills.
Notice Period: Below 30 days
Work Location: Chennai (Work from Office)
📌 Technical Writer Specialist (Chennai)
🏢 Inswit
📍 Chennai