LogicLadder Technologies

Job Description :

As a Technical Writer with expertise in API and coding documentation, you will be translating complex technical information into clear, concise, and user-friendly documentation. This role involves collaborating with cross-functional teams, including developers, product managers, and quality assurance, to create documentation that enhances the understanding and usability of software applications and APIs.

Job Responsibilities :

- Develop comprehensive and well organized documentation for APIs, outlining endpoints, request/response formats, authentication methods, and error handling.

- Collaborate with software engineers to understand technical details and functionalities to represent them in the documentation accurately.

- Create clear and concise documentation for software developers, including code samples, usage guidelines, and best practices.

- Ensure that coding documentation follows established style guides and is accessible to developers with varying levels of experience.

- Regularly update documentation to reflect changes in software releases, feature updates, and bug fixes.

- Monitor user feedback and update documentation accordingly to address common issues and improve user experience.

- Work closely with product managers, UX designers, and development teams to gather information and insights for documentation creation.

- Participate in discussions and meetings to stay informed about upcoming features and changes.

- Review and test code snippets and examples provided in documentation to ensure accuracy and functionality.

- Conduct peer reviews and collaborate with development teams to address any documentation-related issues.

Requirements :

- Bachelor's degree in B tech,Computer Science, or a related discipline.

- Strong understanding of programming languages (e.g., Python, Java, JavaScript) and experience in coding.

- Proficiency in working with APIs and documenting their functionalities.

- Excellent written and verbal communication skills.

- Ability to convey complex technical information in a clear and understandable manner.

- Familiarity with documentation tools such as Markdown, Swagger, or other API documentation frameworks.

- Experience with version control systems (e.g., Git) and collaboration platforms.

- Strong attention to detail to ensure accuracy and completeness in documentation.

- Ability to grasp new technologies quickly and adapt to evolving software environments.

- Benefits Medical Insurance for self and spouse provided by the company

- Great exposure working on the fastest growing market

- Great company culture.

- Other benefits in terms of Sodexo coupons to be introduced soon