Google Season of Docs 2021 Team Proposal: How-to Guides

This is the project proposal for Wechaty How-to-guide documentation on which we will be working as a part of Google Season of Docs 2021. We have proposed our timeline so as to complete this work during a span of 09 weeks.

Team members

Vasvi Sood (email: contactvasvisood@gmail.com)

I am a sophomore at NIT, Hamirpur. I am a Tech enthusiast and a story writer. For me combining technology with my writing skills is a natural match. I am passionate about blockchain technology. I am also into competitive programming these days.

Github Handle: https://github.com/vasvi-sood</br> Medium: https://vasvisood1.medium.com/

Abhishek Jaiswal (email: abhishek.iiitbbsr@gmail.com)

Myself Abhishek Jaiswal,a CSE sophomore UG student currently pursuing my B.Tech from IIIT Bhubaneswar.It’s now been more than 8 month, I started writing technical blogs,tutorials,documentation and reviews.I have published many technical with medium and Analytics Vidhya, Devtutorials and Hashnode. I want to learn, build, grow my network, and want to transform open innovation projects into powerful real-world services.

Github Handle: https://github.com/abhishek-iiit</br> Medium: https://abhishek-iiit.medium.com/</br> Hashnode: https://abhishek-iiit.hashnode.dev/

Proposal Video Presentation

Abstract

How to Guide is important because it guides us through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume knowledge of how the product works. On an average 45 - 50% of developers refer to How to guide. It contains instructions on how to use the program, its features and other inbuilt applications as well.

Current State

Currently, the introduction page is available on its official website. It is obsolete, incomplete and misses information, and does not cover the example images of the steps involved that one needs to get when landing on the How to Guide section.

Analysis

Huan and we(Vasvi and Abhishek) had a conversation about the changes that are to be made with the current How-to-Guide section.He said that the community expects to improve and have a new overall structure of this section. The links he shared with us can be found here.

Why is your proposed user documentation an improvement over the current one?

The proposed How to Guide page will be structured to improve and ensure efficiency, consistency, and peace of mind for any end user. It will contain all the information about how to use the bot and its associated images, including its details and some little explanations on how to use each feature of the Wechaty. It will be kept up to date and have notes to follow inorder to learn by doing.

Proposed Changes

• No overview section: It is theoretical and can get boring for the users to go through an entire page just containing an Overview.
• Add events to your bot: Explaining what an event is, emphasising how it can add more value to the bot functionality (adding various use cases as well)
• Add more functionality to your bot (All the work that can be automated with the bot):

1. Dealing with messages: Step by step guide on writing code for dealing with messages giving a short but clear example.
2. Manage Contacts: Step by step guide on writing code for managing contacts giving a short but clear example.
3. Manage Rooms: Define a room. Step by step guide on writing code for managing rooms giving a short but clear example.
4. Send and Accept Friend Requests: Step by step guide on writing code for sending and accepting friend requests giving a short but clear example.
5. Sending and Receiving files: Step by step guide on writing code for sending and receiving files(data) giving a short but clear example.

• Testing your bot: Step by step guide on writing code for testing the bot giving a short but clear example.Puppet Mocker & Starter Template are included in this section.
• Deploying: A short introduction to Wechaty puppet. This should include a step by step guide to deploy the bot on various instant message systems:

1. Wechat
2. Whatsapp
3. TikTok

• Deploy with Docker
• Deploy with Heroku
• FAQ: Answer to all those questions that might hinder users from using its functionalities

Project Goals

• Get the user familiar with Wechaty by this Guide
• Build a step by step how-to guide, without emphasizing on abstract concepts
• Include various use cases
• Add numerous examples and images
• Translate to English and add code snippets wherever necessary
• Make sure that the how to guide page works all the time
• Ensure the user sees results immediately by integrating it with webapp
• Focus on concrete steps, not abstract concepts

Timeline

Week 1

• This week we will concentrate on community bonding and get familiar with the project with the help of mentors.
• We will chalk out a blueprint for carrying out the complete project.
• Add a README file to GitHub to help future contributors understand how to contribute to the How-to-guide page.

Week 2

• Install Wechaty: It will link to Wechaty’s starter github template and will have a step by step guide on cloning and running instructions.
• Add the missing parts (TBW) to different programming languages.
• Add Related Image to each section to make it more interactive and more engaging.
• Verify working of the code in each programming language.

Week 3

• Add Events to your bot: Define what an event is. Provide code snippets along with a brief paragraph about when to use an event. Include code snippets and examples.
• Add Related Image to the section to make it more interactive and more engaging.
• Add the missing parts (TBW) to different programming languages.
• Verify working of the code in each programming language.

Week 4

• Add more functionality to your bot:

1. Dealing with messages: Step by step guide on writing code for dealing with messages giving a short but clear example.
2. Manage Contacts: Step by step guide on writing code for managing contacts giving a short but clear example.

• Add Related Image to each subsection to make it more interactive and more engaging.
• Add the missing parts (TBW) to different programming languages.
• Verify working of the code in each programming language

Week 5

• Add more functionality to your bot:

1. Manage Rooms: Define a room. Step by step guide on writing code for managing rooms giving a short but clear example.
2. Send and Accept Friend Requests: Step by step guide on writing code for sending and accepting friend requests giving a short but clear example.

• Add Related Image to each subsection to make it more interactive and more engaging.
• Add the missing parts (TBW) to different programming languages.
• Verify working of the code in each programming language.

Week 6

• Add more functionality to your bot:

1. Sending and Receiving files : Step by step guide on writing code for sending and receiving files(data) giving a short but clear example.
2. Testing your bot: Step by step guide on writing code for testing the bot giving a short but clear example.Puppet Mocker & Starter Template are included in this section.

• Add Related Image to each subsection to make it more interactive and more engaging.
• Add the missing parts (TBW) to different programming languages.
• Verify working of the code in each programming language.

Week 7

• Deploying : A short introduction to Wechaty puppet. This should include a step by step guide to deploy the bot on various instant message systems:

1. Wechat
2. Whatsapp
3. TikTok

• Deploy with Docker
• Deploy with Heroku
• Add Related Image to each subsection to make it more interactive and more engaging.
• Add the missing parts (TBW) to different programming language
• Verify working of the code to each programming language

(Code for other IM systems also to be included if required)

Week 8

• FAQ : Answer to all those questions that might hinder users from using its functionalities.
• Proofreading the existing tutorials.
• Fixing typos and making minor changes to the documentation, if required.
• Work on improving the existing topics if required.

Week 9

• Adding various images and screenshots,wherever possible.
• Request the mentor feedback
• Work on improvements suggested by the mentor.
• Submit a project report for evaluation to the mentors
• Write and submit a report of our experience as participants’ in Season of Docs

Team Goals

• Have a weekly open discussion about the project.
• Make strategories/plan for the upcoming week together.
• Examine each other’s work and help out each other.

Proposed Budget

For the How-to-guide section, we have an overall budget of 1000 USD which we intend to divide equally.