Skip to main content

Google Season of Docs 2021 proposal

Create easy to learn tutorials for beginner users of Wechaty#

Wechaty (current version 0.56, first release in 2016) is an Apache-2.0 licensed Conversational RPA SDK for Chatbot Makers which can create a bot on almost all popluar popular IMs like WeChat, Whatsapp, WeCom, Gitter, and Lark etc, with a few lines of TypeScript, JavaScript, Python, Go lang, Java, .NET, PHP lang, Scala, and Rust, with cross-platform compatibility including Linux, Windows, macOS, and Docker.

About Wechaty organization#

Most of our contributors come from Asia, and our users are conversational AI developers, machine learning researchers, freelancers who are building chatbot for their clients, and companies who are building commerical services on top of conversational automation, and top 1 scenario is building on top of WeChat/WeCom.

Our largest user is a company that helps enterprise scale their conversations on WeChat/WeWork by providing a Social CRM solution for their clients.

About Wechaty project#

The project’s problem#

Users come to Wechaty website seeking how to use Wechaty to build a chatbot application for solving their problems. Unfortunately, the learning curve is not friendly to our users, they always struggle with setting up with their development environment, can not get started with the simpliest example source code, and find it hard to know what they can do with our API. This problem leads to us losing lots of new users, increased number of questions asked in the community, and lowered user satisfication.

Our current version of the Tutorials is totally a messy structure because they were not planned properly to begin with.

We need to improve the tutorials on our website, the better it is, the happier our user will be!

The project’s scope#

Tutorials are lessons that take the reader by the hand through a series of steps to complete running Wechaty code. They are what our project needs in order to show a beginner that they can achieve something with it.

They are wholly learning-oriented, and specifically, they are oriented towards learning 'how' rather than learning 'what'.

Tutorials need to be useful for the beginner, easy to follow, meaningful, extremely robust, and kept up-to-dated.

The Tutorial project should:

  • Allow the user to learn by doing
  • Get the user started
  • Make sure that the tutorial works all the time
  • Ensure the user sees results immediately
  • Make the tutorial repeatable
  • Focus on concrete steps, not abstract concepts
  • Provide the minimum necessary explanation
  • Focus only on the steps the user needs to take
  • Work with the contributor team to update the documentation on the Wechaty site.

What is out-of-scope for this project#

  • This project is not an API reference, it can link to related pages for references.
  • This project is not for experienced users

We have two committer candidates for mentoring our GSoD project, and we estimate that this work will take three months to complete. The creator of Wechaty @huan (who is the core maintainer of the whole ecosystem) and @rui have committed to supporting the project.

Rui is mainly help the technical writers to:

  1. get understand about the Documentation System: https://documentation.divio.com/
  2. join the Wechaty community as soon as possible and understand all the tools our community is using.
  3. get answered all the questions about Wechaty and the community.

Measuring your project’s success#

As of today, tutorials on our site receive 60% of pageviews of total traffic, the average visit duration is 1.5 min, the bounce rate is 70%.

We will track the above metrics (pageviews, visit duration, and bounce rate) monthly after the documentation is published. We will also track the number of user getting started questions, starting quarterly after the documentation is published.

We would consider the project successful if, after publication of the new documentation:

  • The tutorials pageviews increase by 50%
  • The visit duration on tutorials increases by 50% (>2 minutes)
  • The bounce rate of tutorials decreases by 30% (<50%)

Project budget#

Budget itemAmountRunning TotalNotes/justifications
Technical writer audit, update, test, and publish new documentation for primary project: tutorials5000.005000.00
Technical writer audit, update, test, and publish new documentation for secondary projects3000.008000.00
Volunteer stipends5009500.003 volunteer stipends x 500 each
TOTAL9500.00

Ref: proposal template

Projects#

  1. Tutorials ($5k)
  2. How-to Guides ($1k)
  3. Reconstruct Wechaty landing page with value propositions, @huan, May 01, 2021 ($1k)
  4. References ($1k)
  5. Introduction ($1k)
  6. Landing page ($1k)
  7. gRPC & OpenAPI ($1k)

The excess of the budget will be subsidized by the community.

Wechaty GSoD'21 blogs#

  1. Google Season of Docs ❤️ Wechaty, @huan, Apr 30, 2021
  2. Reconstruct Wechaty landing page with value propositions, @huan, May 01, 2021
  3. Technical writers onboarding
    1. Shwetal Soni: GSOD'21 project proposal for wechaty, Shwetal Soni, May 03, 2021
    2. Soumi Bardhan: Interactive tutorials for newcomers, Soumi Bardhan, May 03, 2021
    3. Joseph Mawa: 2021 Google Season of Docs Technical Proposal, Joseph Mawa, May 03, 2021
    4. Abhishek Jaiswal :Project Proposal for GSoD'21, Abhishek Jaiswal, May 03, 2021
    5. Sajen Sarvajith K: Blog Post for interactive tutorial (Google Season of Docs 2021 Proposal), sajen sarvajith, May 03, 2021
    6. Google Season of Docs 2021 Applicant: Souvik Biswas, Souvik Biswas, May 04, 2021
    7. Google Season of Docs 2021 Volunteering Proposal, Simin Liao, May 04, 2021
    8. Hi I'm Rohitesh interested in volunteering, Rohitesh Kumar Jain, May 04, 2021
    9. Shraddha Vasant Prasad: 2021 Google Season of Docs Technical Proposal, Shraddha Vasant Prasad, May 05, 2021
    10. Proposal for Volunteering in GSoD '21, Rajiv Ranjan Singh, May 06, 2021
    11. Vasvi Sood: 2021 Google Season of Docs Application, Vasvi Sood, May 06, 2021
  4. Team proposals
    1. Google Season of Docs 2021 Team Proposal - Tutorials, Souvik Biswas, May 11, 2021
    2. Google Season of Docs 2021 Team Proposal - How-to Guides, Abhishek Jaiswal, May 12, 2021
    3. Google Season of Docs 2021 Team Proposal - References, Soumi Bardhan, May 11, 2021
    4. Google Season of Docs 2021 Team Proposal - Introduction and Explanation, Joseph Mawa, May 13, 2021
    5. Google Season of Docs 2021 Team Proposal - Reconstruct Wechaty landing page with value propositions, sajen sarvajith, May 12, 2021
    6. Google Season of Docs 2021 Team Proposal - gRPC & OpenAPI, Rajiv Ranjan Singh, 2021
    7. Google Season of Docs 2021 Team Proposal - Volunteering, Rohitesh Kumar Jain, May 12, 2021
  5. Hello Wechaty GSoD’21 Technical Writers!, @huan, May 08, 2021
  6. Weekly meetings
    1. GSoD'21 Week 1 meeting, @Rohitesh Kumar Jain, May 16, 2021

Contact us#

If you are a Technical Writer and you are interested to contribute in wechaty project for Google Season of Docs 2021, Please send your proposal (by following the template of writing the statement of interest from Google) to our mail list at wechaty@googlegroups.com (web archive), and then introduce yourself after joining our Wechaty Gitter.im channel for connecting.