Skip to content

Commit fb57f12

Browse files
navneetraohaodeqi
authored andcommitted
fix(README): Update documented content for future contributions (#18)
* chore(CONTRIBUTING): Add a contributing page * chore(README): Update readme with links to new resources * fix(README): Fix typos in new content
1 parent 6a4c729 commit fb57f12

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

Diff for: CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## How to contribute
2+
3+
If you'd like to contribute, start by searching through the [issues](https://github.com/watson-developer-cloud/assistant-dialog-skill-analysis/issues) and [pull requests](https://github.com/watson-developer-cloud/assistant-dialog-skill-analysis/pulls) to see if anyone else has raised a similar issue.
4+
5+
If you don't see an issue listed, and you think it fits into the intended use of this repository, do this:
6+
* **If your contribution is minor,** such as a bug fix, open a pull request.
7+
* **If your contribution is major,** such as a new feature, start by opening an issue first. Others can then weigh in before you commence any work.

Diff for: README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
# Dialog Skill Analysis for Watson Assistant
22

33
## Introduction
4-
Dialog Skill Analysis for Watson Assistant is intended for use by chatbot designers and developers who would like to recognize and remediate issues in the design of their dialog skill
4+
Dialog Skill Analysis is a Python framework along with an easy-to-use Python notebook to help you quickly and effectively build AI assistants using Watson Assistant
55

6-
We assume familiarity with the Watson Assistant product as well as concepts involved in dialog skill design like intent, entities, utterances etc.
6+
Whether you are new to the process and are building your first AI assistant or you’re a veteran and have an assistant working well in production, this framework is intended to help everyone with questions like...
7+
- How do I know my assistant is doing a good job?
8+
- How do I test and measure my assistant’s performance?
9+
- Why is the assistant responding incorrectly to this question?
10+
- How do I improve my assistant’s ability to understand questions?
711

812
## Usage
913
1. Assumes familiarity using a Python Jupyter notebook
1014
2. Assumes a Python 3.6 or greater environment (We recommend using Anaconda to setup a python environment)
1115
3. Install dependencies with `pip install -r requirements.txt`
1216
4. Start jupyter server with `jupyter notebook`
13-
5. Select `skill_analysis.ipynb` to start session
17+
5. Run `skill_analysis.ipynb` to start session
18+
19+
## Guides
20+
An introduction to Dialog Skill Analysis on Medium: [Announcing Dialog Skill Analysis](https://medium.com/ibm-watson/announcing-dialog-skill-analysis-for-watson-assistant-83cdfb968178?)
21+
22+
## Hosted Python Notebook
23+
For those of you familiar with IBM Watson Studio, we have also made a hosted version of the notebook available on the IBM Gallery: [Hosted Dialog Skill Analysis Notebook](https://dataplatform.cloud.ibm.com/exchange/public/entry/view/4d77701840fcb2f21587e39fdb887049)
1424

1525
## Contributor List
1626

0 commit comments

Comments
 (0)