Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Virtual assistant to improve the experience of Codewind users by providing immediate attention to their questions #698

Merged

Conversation

sujeilyfonseca
Copy link
Contributor

@sujeilyfonseca sujeilyfonseca commented Jul 21, 2020

Signed-off-by: Sujeily Fonseca sujeily.fonseca@ibm.com

What type of PR is this ?

  • Bug fix
  • Enhancement

What does this PR do ?

Includes a virtual assistant to improve the experience of Codewind users by providing immediate attention to their questions.

The virtual assistant is called Bree-Z. It started as a POC project were an IBM Developer JumpStart team was mentored to design and develop a solution to address the following business problem:

  • Difficult to find troubleshooting information for Codewind
  • Limited engagement from potential contributors and advocates
  • Multiple channels of information
  • Development team spending too much time on Q&A

The chatbot development was done under the mentoring on Brandy Byrd (Product Owner), Sujeily Fonseca (Technical Mentor/Leader), and Lisa Schenkewitz (Design Thinking Coach).

The design was based on input from a Junior Developer, Senior Developer, Integration Team Leader, and Business Stakeholders. It passed throughout two testing phases with Codewind developers, Codewind leaders, Watson leaders, Content developers, and general individuals.

It was intended to go through a third testing phase with a Hack-A-Chat event but was not possible. However, I worked to fix some bugs, enhanced the dialog tree, enhanced the search feature, and updated its content based on the latest.

Bree-Z is capable of:

  • Answer common questions related to Codewind
  • Provide an overview and redirect people to the right place in our documentation
  • Guide you to answer some questions and generate a template for a bug or question type issue, and link you to where the issue can be added
  • When the dialog tree is not capable of answer the user question or the confidence is lower than 50%, it will try to use search skill to gather info among GitHub, Codewind Dev Page, and Medium.
  • Others: Tell jokes, understand some common phrases, etc.

Bree-Z was build using Watson tools.

Which issue(s) does this PR fix ?

eclipse-archived/codewind#3212

Does this PR require a documentation change ?

N/A

Any special notes for your reviewer ?

Bree-Z can be tested by clicking on the chat button available at the bottom-right corner:

Screen Shot 2020-07-21 at 1 08 31 AM

The avatar was designed specifically for Codewind, so its original:

Screen Shot 2020-07-21 at 1 08 59 AM

Feel free to request any necessary changes.

…iding immediate attention to their questions

Signed-off-by: Sujeily Fonseca <sujeily.fonseca@ibm.com>
@sujeilyfonseca
Copy link
Contributor Author

Please, assign this pull-request to @jcockbain. Thanks!

Copy link
Contributor

@jcockbain jcockbain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Functionally looks good to me, tested the chatbot with the questions and works well. The only small issue I can see is there's a small margin introduced below the footer with the change.

image

Looking now as to what is causing this.

Signed-off-by: Sujeily Fonseca <sujeily.fonseca@ibm.com>
@sujeilyfonseca
Copy link
Contributor Author

Thank you very much for taking the time to provide feedback and review the pull-request, @jcockbain!

I added a commit to fix the small margin introduced below the footer.

Copy link
Contributor

@jcockbain jcockbain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified that the latest change fixes the margin. LGTM

@sishida
Copy link
Contributor

sishida commented Jul 27, 2020

@sujeilyfonseca, @jcockbain: Hi, team, Is this PR ready to merge? Please let us know so we can add committer approval and have a committer merge. Thank you!

(Also tagging @micgibso for awareness.)

Copy link
Contributor

@micgibso micgibso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants