I am Shraddha Vasant Prasad, Software Engineer at American Express ,I describe myself as "A creative person by nature and a passionate developer ,blogger and lastly Open Source Enthusiast.
Soumi Bardhan, a CS Junior at IIIT Kalyani and Ex- Goldman Sachs Intern. She loves solving real world problems with deep learning and AI. She documents her experiences through technical articles on medium.
{% include iframe.html src="https://www.youtube.com/watch?v=82rFox9Vq14" %}
This is the project proposal for Improve the Wechaty References on which we will be working as a part of Google Season of Docs 2021. Soumi and I have proposed our timeline to complete this work during a span of 17 weeks. User docs are an important feature of any software product it assists the end-users in using the software poftware product or a service.The excellent user docs site is a sign of the healthiness of the product, the developer team.The good user documentation makes the product or a service easy to use .
After analysis of the introduction section, following issues were seen:
- The references page is difficult to understand for first time users technically.
- It is incomplete ,abstract and outdated.
- Many information is given in Chinese language and hence difficult for global users to understand.
References contain the technical reference for APIs and other technical aspects of the Wechaty machinery.It describes how it works and the way it works. The scope of this project is limited to improving the References section of the wechaty.js.org website.
- Make a neat index to search through the references section with ease
- Building a step by step guide for references
- Add snippets wherever possible with appropriate images to make it look more attractive.
- Include more use cases
- Add English translations to already existing Chinese language information
- Focus on concrete steps
- At end of our project tenure we will definitely make the Reference page perfect & top-notch
- Weekly phone calls with each other for discussion
- Also setup a personalized channel for small discussions
- Check each other鈥檚 work and help out
- Set weekly goals together during the phone calls
