Abhishek Jaiswal :Project Proposal for GSoD'21

最新推荐文章于 2025-03-29 09:20:48 发布

原创最新推荐文章于 2025-03-29 09:20:48 发布 · 179 阅读

0 ·

CC 4.0 BY-SA版权

本项目旨在通过重新设计和更新现有教程来改善Wechaty的用户体验。计划包括更新文档、添加示例代码、提供视频教程及英文字幕，确保内容易于理解且全面覆盖Wechaty的功能。

Introduction

Hello, ChatBot Developers!

Myself Abhishek Jaiswal,CSE sophomore from IIIT Bhubaneswar,India and a MSFT student ambassador interested in improving the tutorials of Wechaty.

My past Technical Writing Experience

Technical Writer - AnalyticsVidya@medium & Devtutorials@medium Technical Writer - Hashnode Video Production Manager - Qualki

Project Proposal

Abstract

A easy-to-learn tutorials are designed to assist end users to get familiar with the product or service. Good tutorials are very important because it provides an avenue for users to learn how to use a software, its features, tips, tricks. It also reduces support cost and is part of the corporate identity of the product: a good tutorials as well as user documentation is a sign of healthiness of the product, the developer team. Without good tutorials, a user may not know how to do the above things effectively and efficiently. Also User Documentations can play a pivotal role in ensuring a product’s success because great communication is and will always be at the heart of any business or product and a great documentation just takes that communication and puts it in a manageable framework that everyone can access for success. At the time of this writing, the Wechaty now has more than 9900 Stargazers over time and the having no downtime after 12th Nov,2020 for the API and FridayBot, this shows that a lot of people all over the world use the Wechaty and may want to read its tutorials for guidance on how to use the the chatbot maker. However, the Wechaty tutorial is currently outdated and incomplete and the Wehchaty community wants to use this project to improve its tutorials and user documentation to enable end users to have a seamless experience when using the Wechaty.

Current State

Currently, the tutorials are available on its official website. It is obsolete, incomplete,hard to navigate or find information, does not cover code about some programming language of the chatbot maker and some posts and tutorials are written in Chineselanguage which causes a major setback for people who can’t read the Language.

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

The proposed user tutorials will be structured to improve and ensure efficiency,consistency, and peace of mind for any end user. It will contain written guides and its associated images, include instructions and explanations on how to use each feature of the Wechaty, up to date, allow the user to learn by doing, understandable and translatable in English languages as well all the blogs,posts,video subtitles as well.

Analysis

Huan and I had a conversation about the new changes that are to be made with the current tutorials and he shared two links that showed a project’s scope file written with Docusaurus documentation system v2 and a tutorials docs given on wechaty and said they expect to enhance the contents under the tutorial sub menu. The links he shared with me can be found here and here. I researched a lot about these tools to get a better understanding of how it works.

Docusaurus documentation system v2

Docusaurus makes it easy to maintain Open Source documentation websites. Docusaurus currently provides support to help the website use translations, search, and versioning, along with some other special documentation markdown features.Some of its features are :

Powered by Markdown
Built Using React
Ready for Translations
Document Versioning
Document Search

It makes design and documentation changes by using the included live server. Also, it publishes the site to GitHub pages or other static file hosts manually, using a script.

Project Goals

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

My Previous Contribution

Timeline

Doc development(Before 30 April)

Continue making contributions to the organisation.
Become more familiar with the current tutorials and make a blueprint of the changes to be done.
Learn new technologies and technical writing skills which will be helpful while implementing the project.
Learn more about the community and product.
Discussing the proposed documentation structure with the mentor and other members of the organisation.
Finalised the proposed feature and other modifications that need to be made with existing tutorials.

Week 1 (1nd May - 8th May)

This week I will focus on setting up the GitHub repository which I will use to push and pull all the changes I have made.

If a Github repository for the documentation has already been created by the Wechaty community before the beginning of the documentation period, I will fork the repository so that I can be making changes to my branch directly before creating a pull request to the main repository to be reviewed and merged by the mentor. If not, I will create a repository for the documentation on GitHub (of course after taking permission from the mentor).
Add a README file to GitHub to help future contributors understand how to contribute to Wechaty documentations and tutorials.
I will write documentation on two subheadings in the Getting Started section of the documentation.
Why Wechaty: A brief introduction and some little history of the Wechaty community and Chatbot Maker.
List of Examples: To excite people to use this chatbot maker.
Commit the newly made changes to my branch and create a pull request for review.

Week 2(9th May - 15th May)

Help & Contact :To mention all the necessary links and references with details.
Quick Start Setup : A quick easy to understand setup tutorial with necessary images and easy-to-understand words.
Installation : Straightforward installation with images for each step in installation.

Week 3(16th May - 22nd May)

Showcase : To translate language as well as rearrange the topics in block form for better User Interface.
Hands-on tutorial’s Homepage :To translate page and retransform page for better experience.4
Basic tutorials for beginners : To add a well explained introduction and some wechaty images to make interests for the users.

Week 4(23rd May - 29th May)

Video Tutorial (Money Bot) : To translate the entire page and to add english subtitles to the video.
Create a bot : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.
Listen to events : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.

Week 5(30th May - 5th June)

Video Tutorial (Assistant Bot) : To translate the entire page and to add english subtitles to the video.
Deal with message : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.
Manage rooms : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.

Week 6(6th June - 12th June)

Video Tutorial (Coaxer Bot) : To translate the entire page and to add english subtitles to the video.
Make friends : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.
Process files : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.

Week 7(13th June - 19th June)

Manage contacts : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.
Write tests : To reorganise the page, add items to left fields and conversion of codes to 5 different programming languages.
Construct page for Heroku usage : To add content along with some visuals for better experience.

Week 8(20th June - 26th June)

Construct page for Heroku usage : To add content along with some visuals for better experience.
Construct page for Heroku usage : To add content along with some visuals for better experience.
Reorganise Pugin with wechaty page : To reorganise all the content and add some photos for making it interesting.

Week 9(27th June - 3rd July)

Reorganise Pugin with wechaty page : To reorganise all the content and add some photos for making it interesting.
Reorganise Pugin with wechaty page : To reorganise all the content and all photos for making it interesting.5
Examples and cheatsheet : Add some new examples and make new cheatsheet for the project.

Week 10(4th July - 10th July)

Conversion of Blogs to english language with possible images as well :

How do I use Chatbot to reconstruct the sales system in Qiji Innovation Forum,@rickyyin
Chatbot’s application in customized travel industry,@likai
Microsoft Tech Summit-Quickly build a chatbot,@lijiarui

Week 11(11th July - 17th July)

Conversion of Blogs to english language with possible images as well :

Use wechaty to realize news and information broadcasting robot,@judaschrist
Party entertainment robot,@osindex
Wechaty-Let there be no difficult business online, @coderwhocode

Additional Work

Week 12(18th July - 24th July)

To reverify the reference doc,if we have any docs incomplete ,and translate it to english language as well ,and try to complete it within a week:
API references
Polyglot
Puppet providers
Puppet Services
Specifications

Week 13(25th July - 31st July)

To go through Explanations docs ,and translate it to english language as well for easy understanding and well formatted documents.
Overview
Conversational
RPA
Motivation
Concepts
Architecture
Life Cycle
Alternatives
Glossary
FAQ
Troubleshooting
Docusaurus6

Week 14(1st August - 7th August)

This week I will put all my attention on proofreading the documentation for typos and errors.
Submit a project report and evaluation of my mentors
Write and submit a report of my experience as a participant in Season of Docs.