vwxyzh/brainstorm.quiz.md

## brainstorm.quiz.md

      
    Raw
  

              brainstorm.quiz.md
            
          
What this markdown file talking about:

 Brainstorming of markdown file format for quiz.
 Finallize the spec.
 Anything about Quiz Service


Can quiz support multi-choice and single-choice?

 For multi-choice, it is supported natively, this is a sample.
 For single-choice, we try to check whether only one choice is checked.
 Single/multi-choice with hint is opening.


Can this format handle code block or images like following?
Code!


 Yes, you can do it.


 And you can create it in answers like this:
Code!!!!


 No.


Can it support explanation?


 We do not talking about this extension yet.


 Maybe it looks like this one.
:::feedback
Some explanation for this choice.
:::feedback-end


 This is opening by now.


What the advantage of this format for quiz?

 Easy to preview on GitHub site.
 Reuse current syntax supported in markdig.
 Support code or images natively.
 Support multi-choice natively.
 No work for localize.
 No work for build


What is the work flow?


 OPS Build read this markdown file (no work).


 OPS Build parse the content to AST (little work).


 OPS Build transform the AST to quiz model (very like markdown fragment).


 OPS Build submit model to DHS (in json format).
{
  "quiz_id": "some id",
  "commits": "12345678",
  // other properties
  "questions": [
    {
      "question_id": 1,
      "question": "<html>for question</html>",
      "choices": [
        {
          "choice_id": 1,
          "correct": true,
          "choice": "<html>for choice 1<html>"
        },
        {
          "choice_id": 2,
          "correct": false,
          "choice": "<html>for choice 2<html>"
        }
      ]
    },
    // ...
  ]
}


 Quiz Service read the model and extract useful information.


 Rendering read from DHS or Quiz Service (opening).