Job Description
Technical Writer
Job Description: Technical Writer (4–6 Years of Experience)
Location: Bengaluru
Job Type: Full-Time
Role Overview:
We are looking for an experienced Technical Writer with 4–6 years of relevant experience to join our team. The ideal candidate will have the ability to understand complex systems, including code and end-to-end platform workflows, and create clear, comprehensive, and precise documentation. A background in cloud-based platforms, IoT, AI technologies, and proficiency in tools and methods for technical writing is essential.
Key Responsibilities
Documentation Creation and Maintenance:
Develop and maintain high-quality technical documentation, including user manuals, API guides, integration guides, and system architecture overviews.
Simplify complex concepts and workflows for a diverse audience, including developers, testers, and non-technical stakeholders.
Code Understanding:
Analyze Java, Angular, React JS, and database structures (e.g., MySQL) to create detailed technical documentation.
Collaborate with development teams to understand and document code-level details effectively.
End-to-End Platform Knowledge:
Gain a deep understanding of the entire product platform, from backend services to frontend interfaces and IoT/AI functionalities.
Document platform workflows and processes, ensuring clarity and usability for both internal teams and end-users.
Collaboration and Review:
Work closely with developers, QA engineers, and product managers to gather technical information and clarify requirements.
Review and edit documentation for accuracy, completeness, and adherence to standards.
Continuous Improvement:
Research and implement best practices for technical writing to enhance documentation quality.
Stay updated on platform updates and ensure documentation evolves alongside the product.
Qualifications
Experience and Skills:
4–6 years of experience in technical writing with a strong focus on documenting software systems.
Proven ability to understand and document code written in Java, Angular, React JS, and other relevant technologies.
Solid understanding of database structures, particularly MySQL, and the ability to document database workflows.
Familiarity with tools such as Markdown, DITA, Confluence, or other documentation platforms.
Soft Skills:
Exceptional written and verbal communication skills.
Attention to detail with a knack for simplifying complex topics.
Collaborative mindset and ability to work effectively with cross-functional teams.