diff --git a/README.md b/README.md index c17fc7e..a457b3f 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,23 @@ Quicklinks: [Documents](https://drive.google.com/drive/folders/1YpAaD8_mvSkpHuIvbIJmsb08GLVQt8iE?usp=sharing) | [OpenAPI Spec](https://covopen.github.io/CovQuestions/swagger/index.html) -# CovQuestions +# Questionnaire Engine This project provides a way to maintain and quickly adapt complex Questionnaires and their evaluation in mutliple languages and versions. It also provides a javascript engine to run those Questionnaires in any environment, e.g. on a website, telephone-hotline or chatbot. ## Structure -### [Questionnaire Editor](/covquestions-editor-app/README.md) ([Demo](https://covquestions.z16.web.core.windows.net/)) +### [Web-based Integrated Development Interface (IDE)](/covquestions-editor-app/README.md) ([Demo](https://covquestions.z16.web.core.windows.net/)) -The Editor allows a quick adaption of any Questionnaire, it allows do define, try and test them via a WebApp. -You can define questions and logic to display specfic Questions depending on answers from others or a scoring logic. -At the end the Questionnaire can give a first Evaluation based on it logic. -All of this can be tested manually and automatically in the editor. +The web-based IDE allows to create, update and test a questionnaire and recommendation logic. +You can define questions and logic to display specfic questions depending on answers from others or a scoring logic. +At the end the questionnaire personalized recommendations are created. +All of this can be tested manually and automatically in the IDE. ### [Questionnaire Engine](./covquestions-js/README.md) ([Docu](https://covopen.github.io/CovQuestions/)) The Engine allows you to run any specified questionnaire interactively. -#### [Covscript](./covscript/README.md) +#### [Script Language](./covscript/README.md) A custom parser to make it easier to work with `json-logic` which we use under the hood for the questionnaire logic.