We are looking for a technical documentation writer to write API documentation of our software using Swagger.
Selected intern's day-to-day responsibilities include writing documentation of all our internal API's using Swagger's annotations. The intern will be given read-only access to our codebase and also given a complete training of the front end system usage as well as high-level code understanding. Thereafter, the intern has to:
1. Read and understand the code where APIs are defined
2. Use Swagger annotations and write required explanations for each of our API endpoints (refer to this video https://youtu.be/8s9I1G4tXhA?t=598 at minute 9:58 on how to do this)
3. Interact with the developer who has written the code (where required) and understand how it works
4. Make changes to the API documentation based on changes to API, review comments by the management and feedback from external consumers of our API documentation
Only those candidates can apply who:
1. are available for the work from home job/internship
2. can start the work from home job/internship between 5th Jun'20 and 10th Jul'20
3. are available for duration of 2 months
4. have relevant skills and interests
* Women wanting to start/restart their career can also apply.
1. Knowledge of using Swagger [https://swagger.io/]
2. Ability to understand Java and JavaScript code
3. Good technical writing skills
4. Do not apply if you are not technically proficient to undertake this task
While we understand that interns would not have work experience, but we would not want to hire someone without knowledge of the above. If you have the knowledge, we are happy to provide you with the required platform to gain experience.
We are building an intelligent travel planner used across the lifecycle of planning, booking, and managing a holiday. The product has been live in the market and is now gaining traction. Our technology stack consists of: web portal = Angular7 + Java-Spring + Zuul Microservices, mobile app = Native/Ionic/React Native. Currently, product engineering, project management, application architecture, and business analysis functions are run by the founders. We believe Darwin is at the tipping point of gaining escape velocity and candidates can expect to reap growth along with the team and business.
