Requirement Specification Document for the TIMCAN Project
Version 1.0.0
4.6.2019
Public
Hanna Alatalo
Jarkko Kuivanen
Elisa Nauha
Jere Ojala
Kimmo Urtamo
University of Jyväskylä
Faculty of Information Technology
Jyväskylä
Signatures
| Approved by | Date | Signature | Name clarification |
|---|---|---|---|
| Project Lead |
Elisa Nauha |
||
| Customer representative |
Ari Huhta |
||
| Supervisor |
Jukka-Pekka Santanen |
Change log
| Version | Date | Changes | Made by |
|---|---|---|---|
| 0.0.1 | 3.5.2019 | Writing of the document was started. | KU |
| 0.0.2 | 6.5.2019 | The requirements for creating a task and a test were added. | KU |
| 0.1.0 | 7.5.2019 | The rest of the requirements were added. | KU |
| 0.1.1 | 9.5.2019 | The priorities of the requirements and the number of fulfilled requirements were added. | KU |
| 0.1.2 | 10.5.2019 | Corrected multiple issues in the document. | KU |
| 0.2.0 | 14.5.2019 | The fulfillment of the individual requirement groups was added. | KU |
| 0.2.1 | 15.5.2019 | Minor modifications to requirements were made. | KU |
| 0.3.0 | 17.5.2019 | Some typos were fixed and fulfillment of individual features were changed to be presented in a single table. | KU |
| 0.3.1 | 21.5.2019 | Removed info about project room and dropped the signature requirement from both customer representatives. | KU |
| 1.0.0 | 4.6.2019 | The document was approved by the customer. | KU |
Project organization
Project group
- Hanna Alatalo (HA),
hanna.m.alatalo@student.jyu.fi - Jarkko Kuivanen (JK),
jarkko.t.kuivanen@student.jyu.fi - Elisa Nauha (EN),
elisa.k.nauha@student.jyu.fi - Jere Ojala (JO),
jere.j.ojala@student.jyu.fi - Kimmo Urtamo (KU),
kimmo.j.urtamo@student.jyu.fi
Customer representatives
- Ari Huhta,
ari.huhta@jyu.fi - Dmitri Leontjev,
dmitri.leontjev@jyu.fi
Supervisors
- Visa Naukkarinen, technical supervisor,
visa.naukkarinen@gmail.com - Jukka-Pekka Santanen, corresponding supervisor,
santanen@mit.jyu.fi
TIM-experts
- Mika Lehtinen ,
mika.k.lehtinen@student.jyu.fi - Vesa Lappalainen,
vesa.t.lappalainen@jyu.fi
Contact information
- E-mail lists
timcan@korppi.jyu.fitimcan_opetus@korppi.jyu.fi
- E-mail archives
Information about the document
Document name: Requirement Specification Document for the TIMCAN Project
File:
https://tim.jyu.fi/view/kurssit/tie/proj/2019/timcan/dokumentit/requirement_ specification
Summary: The features developed to the TIM system in the TIMCAN project will replace the ICAnDoiT application currently used by the Centre for Applied Language Studies. The features allow the creation of adaptive feedback, presenting it to students while they are doing exercises and exporting reports about learning for research purposes. The document describes the application domain, requirements for the application as well as their fulfillment, priorities and statuses.
Keywords: Adaptive Feedback, Centre for Applied Language Studies, Functional Requirements, ICAnDoiT, Plugin, Requirement Specification, The Interactive Material, TIM.
1. Background and goals of the application
The TIMCAN project developed new functionalities for the TIM system developed in the Faculty of Information Technology at the University of Jyväskylä. The goal of the project was to make the system more suitable for the Centre of Applied Language Studies. Currently, they are using an application called ICAnDoiT that is no longer developed or supported. The project developed the functions in the ICAnDoiT application into the TIM system.
The most important function of the ICAnDoiT application to be transferred to TIM is providing adaptive feedback, which means that the feedback received by the learner depends on their previous answers. It was also necessary to develop new exercise types supporting the feedback to the TIM system for the learner to answer. The path of the learner's answers was collected into a report which was important for research purposes. The functions described above are universally available to all users of the TIM system.
The requirements specification was used for managing and tracking the requirements during the course of the project. Chapter 2 establishes the concepts used later on. The priorities and states that the requirements are tracked with are described in chapter 3. Chapters 4-11 contain the requirements of the functions being developed as well as their priorities and states. Finally, the fulfillment of the requirements are presented in chapter 13.
The document contains only functional requirements. Technical requirements or requirements concerning quality are not included. The document also doesn't go into details about the challenges, goals or needs of the project. Instead, those are covered in the project plan [1] (in Finnish) of the TIMCAN project. Other notable documents are the project report [2] (in Finnish) and the application report [3]. There is also a user manual [4] available and instructions [5] for further development.
2. Concepts
The essential concepts used in the document are the following:
- Adaptive feedback or feedback is feedback for the learner that changes depending on the answer given and the feedback level.
- CSV (Comma-Separated Values) is a text file format where values are separated with commas.
- Exporter is a TIM user role that has answer rights to the test documents.
- Feedback level tells how specific feedback the learner receives based on their answers. Feedback level increases with incorrect answers.
- Learner is a TIM user role that has view rights to the test documents.
- Paragraph editor is a text editor used in TIM to modify text paragraphs.
- Plugin is a part of TIM system that adds functionality to documents.
- Question item is a single question that contains at least one plugin supported by the application.
- Task is a collection of similar question items (targeting the same skill / area) with adaptive feedback included.
- Test is a collection of tasks.
- Test creator is a TIM user role that has manage rights to the test documents.
- TIM is an interactive study environment developed in the University of Jyväskylä.
- User is the end-user of the application.
- User role or role is a usertype that has certain responsibilities, rights or tasks in relation to the system being used.
3. Priorities and states of the requirements
The following priorities are used in the requirements:
- Essential requirement is necessary for the application to function.
- Important requirement gives high value to the user but is not required for the application to function.
- Possible requirement is a quality of life improvement or the value is minimal compared to development work.
- Idea specifies that the requirement needs are not clear yet or there are not enough available resources to fulfill the requirement during the project. It should be considered in subsequent projects.
- Discarded requirement has been deemed unnecessary.
The document also tracks the realization of requirements by using states. The following states are used:
- In TIM specifies that the requirement has already been completed in the TIM system.
- Approved requirement has been completed, tested and approved.
- Tested requirement has been completed and tested but not approved.
- Completed requirement has been completed but not tested.
- Unfinished requirement is under development.
- Not Started specifies that the development of the requirement hasn't begun yet.
- Not Implemented specifies that agreement has been made with the customer to not implement the requirement to the TIM system during the project.
4. Requirements for creating a test
| No. | Description | Priority | State |
|---|---|---|---|
| 1.1 | A test shall be created by creating a TIM folder. | Essential | Completed |
| 1.2 | Only one test shall be contained within a single TIM folder. | Essential | Completed |
| 1.3 | An error shall be presented if there is more than one test within a TIM folder. | Idea | Not Implemented |
| 1.4 | A test shall include a TIM document explaining the assignment. | Important | In TIM |
| 1.5 | An error shall be presented if a test does not include a TIM document explaining the assignment. | Idea | Not Implemented |
| 1.6 | A test shall include at least one task. | Essential | Completed |
| 1.7 | An error shall be presented if the test does not contain at least one task. | Idea | Not Implemented |
| 1.8 | A test shall include a TIM document to conclude the test. | Important | In TIM |
| 1.9 | An error shall be presented if a test does not include a TIM document concluding the test. | Idea | Not Implemented |
| 1.10 | The test creator shall define the rights to the test for the learners. | Important | Completed |
| 1.11 | The test creator shall define the rights to a test's tasks for the learners. | Important | Completed |
| 1.12 | A user with manage rights shall be able to modify a test. | Important | In TIM |
| 1.13 | A user with manage rights shall be able to remove a test. | Important | In TIM |
| 1.14 | The learner shall be dynamically granted or revoked access to the tasks in the test while they are completing the test. | Idea | Not Implemented |
1.3: ihan vain mielenkiinnosta, mitä nyt tapahtuu /seuraa jos jostain syystä joku laittaa 2 tai useamman testing samaan TIM-kansioon?
—sama kysymys koskee noita muitakin tämän kohdan ideoita virheviesteistä; oletan että testin laatija huomaa helposti jos ei noudata näitä yleistiä TIM-periaatteita
—Jos on useampi testi samassa kansiossa, kaikkien testien tiedot tulevat vain samaan raporttiin jos pyytää raportin koko testistä. Periaatteessa raportin muodostuksessa saattaa tulla ongelmia ja tiedot voivat näkyä väärin jos henkilö tekee kahta testiä samaan aikaan, mutta tätä emme ole kokeilleet.
Mikäänhän ei rikkoonnu, jos jättää esimerkiksi tuon alkuselostusdokumentin tekemättä ja luo pelkkiä tehtäväsarja-dokumentteja, testi ei vaan silloin ole saman kaltainen kuin ICAnDoiT-testit. Sitä, onko testin tekijä luonut tuon alkuselostusdokumentin tai 10 testiin liittymätöntä dokumenttia testikansioon on vain vaikea valvoa ilman, että rajoittaa dokumentin luontia jollain kiintopisteellä, mikä on mahdollista tarkastaa koodissa.
—5. Requirements for creating a task
| No. | Description | Priority | State |
|---|---|---|---|
| 2.1 | The first item in the task shall be a TIM block with the instructions regarding the task. | Essential | Completed |
| 2.2 | The task shall include at least one TIM block with a question item. | Essential | Completed |
| 2.3 | A question item shall include at least one plugin for the learner to answer to. | Essential | Completed |
| 2.4 | The last item in the task shall be a TIM block with the feedback plugin of the task. | Essential | Completed |
| 2.5 | The task may be created using the paragraph editor. | Essential | Tested |
| 2.6 | The task may be created by using templates in the paragraph editor. | Essential | Completed |
| 2.7 | The task and it's feedback may be inside the same TIM area. | Possible | Completed |
| 2.8 | The number of consecutive answers to end the task shall be defined in the feedback. | Essential | Tested |
| 2.9 | A user with manage rights shall be able to modify a task. | Important | In TIM |
| 2.10 | A user with manage rights shall be able to remove a task. | Important | In TIM |
6. Requirements for test presentation
| No. | Description | Priority | State |
|---|---|---|---|
| 3.1 | UI components in TIM unrelated to the test shall be hidden from the learner when the learner is doing the test. | Essential | Completed |
| 3.2 | The learner shall be presented a test description when beginning the test. | Essential | Completed |
| 3.3 | The learner shall be presented instructions when starting a new task. | Essential | Tested |
| 3.4 | The learner shall see the instructions of a task only when starting a task. | Essential | Tested |
| 3.5 | The learner may be presented a practice item for a new task. | Essential | Tested |
| 3.6 | The task instructions and the practice item may be presented individually instead of together. | Idea | Not Implemented |
| 3.7 | The learner shall be presented a practice question item when starting a new task if one is defined by the test creator. | Important | Tested |
| 3.8 | A practice question item shall not give feedback. | Important | Tested |
| 3.9 | A question item shall be presented after the learner confirms the task instructions. | Essential | Tested |
| 3.10 | The question items for the learner to answer shall be presented randomly. | Important | Completed |
| 3.11 | A new question item shall be presented after the learner confirms the feedback. | Essential | Tested |
| 3.12 | After confirming the instructions, the learner shall only see a question item or feedback related to a question item. | Essential | Tested |
| 3.13 | The instructions on how the learner should proceed forward shall be presented after the task has ended. | Important | In TIM |
| 3.14 | All the feedback, instructions and correctly answered question items that were previously presented to the learner in the task shall be hidden from the learner. | Essential | Tested |
| 3.15 | Previous feedback, instructions or question items of a task shall be shown to the learner if specified in the task settings by the test creator. | Idea | Not Implemented |
| 3.16 | If the test creator has edit mode open in the TIM document, instructions and every question item in the task shall be visible to the test creator. | Possible | Completed |
| 3.17 | The answers to a task in a test shall only be visible in the answer mode of a document. | Possible | Completed |
| 3.18 | The answers to a task in a test may be visible in the view mode of a document if defined by the test creator. | Possible | Completed |
7. Requirements for test progression
| No. | Description | Priority | State |
|---|---|---|---|
| 4.1 | The test shall start with a description document explaining the test. | Essential | In TIM |
| 4.2 | The task shall start with instructions that the learner must acknowledge to proceed. | Essential | Tested |
| 4.3 | If the learner tries to leave or reload the page when a task has begun, they shall be presented a warning. | Important | Completed |
| 4.4 | When the learner is doing a task, they shall progress between a question item or feedback until they reach the end of the task. | Essential | Completed |
| 4.5 | The answer to a question item shall be confirmed by the learner before receiving feedback. | Essential | Tested |
| 4.6 | The learner may proceed to the next question item without selecting an answer to the current question item if defined by the test creator. | Idea | Not Implemented |
| 4.7 | A task shall end when the learner has answered correctly to all question items in the task. | Important | Completed |
| 4.8 | A task shall end when there are no more question items to present. | Important | Completed |
| 4.9 | A task shall end when the last level of adaptive feedback is reached. | Essential | Tested |
| 4.10 | A task shall end when the defined number of consecutive answers in the feedback plugin are correct. | Essential | Tested |
| 4.11 | A task shall end when the number of consecutive incorrect answers defined in the feedback plugin by the test creator is reached. | Idea | Not Implemented |
| 4.12 | When a task ends, the learner shall be guided to the next task. | Essential | Completed |
| 4.13 | The test shall end when there are no more tasks to present. | Essential | Tested |
| 4.14 | The learner shall be unable to navigate to a task in the test that the learner is not currently doing. | Idea | Not Implemented |
| 4.15 | If the learner stops doing a test, the task and the question item they stopped in shall be saved. | Idea | Not Implemented |
| 4.16 | If the learner returns to an unfinished test, the test shall continue from where the learner left off. | Idea | Not Implemented |
8. Requirements related to all developed plugin types
| No. | Description | Priority | State |
|---|---|---|---|
| 5.1 | A plugin shall be able to be added to a TIM document by using the paragraph editor. | Essential | In TIM |
| 5.2 | A plugin shall be able to be added to a TIM document by using templates in the paragraph editor. | Essential | In TIM |
| 5.3 | The name of a plugin shall be defined by the test creator when adding a plugin to a TIM document. | Essential | Tested |
| 5.4 | A plugin shall be able to call functions of other plugins that implement the ITimComponent interface. | Important | Completed |
| 5.5 | A plugin shall save the time when acknowledging the user input. | Essential | In TIM |
| 5.6 | A plugin shall save its content when requested by a TIM component implementing the ITimComponent interface. | Essential | Completed |
| 5.7 | A plugin shall save its content when acknowledging the user input. | Important | Tested |
| 5.8 | A plugin may be forced to always save its content by other plugins implementing the ITimComponent interface when an answer is saved. | Important | Completed |
9. Requirements for the plugins used in the question items
The chapter describes the requirements for the two plugins that the TIMCAN project developed to be used in the question items of a task. The plugins are
- a plugin where words are dragged from a pool to a second area to form sentences and
- a plugin where you select the correct answer from a dropdown list of multiple choices.
9.1 Requirements for the drag&drop plugin
| No. | Description | Priority | State |
|---|---|---|---|
| 6.1 | The content in the drag&drop area may be defined when adding the plugin to a document. | Important | Tested |
| 6.2 | The order the content in the drag&drop area is in may be chosen to be randomized the test creator. | Important | Completed |
| 6.3 | Drag&drop content shall be defined in the TIM paragraph editor when creating a drag&drop to the TIM document. | Essential | Completed |
| 6.4 | The plugin may receive its draggable content from a feedback plugin. | Important | Completed |
| 6.5 | The plugin shall return its draggable content on request to other plugins implementing the ITimComponent interface. | Important | Completed |
| 6.6 | The draggable content of the drag&drop may be defined to be discarded by the test creator when saving an answer to the database. | Idea | Not Implemented |
| 6.7 | Drag&drop area shall save its draggable content when acknowledging the user input. | Important | Completed |
| 6.8 | Drag&drop answer shall be able to be saved independent from a feedback plugin. | Important | Completed |
| 6.9 | A Drag&drop area in the question item shall contain at least one dragged word on confirmation. | Important | Tested |
| 6.10 | An error shall be presented if a drag&drop area does not contain at least one dragged word on confirmation. | Important | Tested |
9.2 Requirements for interaction between drag&drop plugins
| No. | Description | Priority | State |
|---|---|---|---|
| 7.1 | The draggable content shall be able to be dragged from a drag&drop area to other drag&drop areas in the document. | Essential | Tested |
| 7.2 | The draggable content from other drag&drop areas in the document shall be able to be dropped to the drag&drop area. | Essential | Tested |
| 7.3 | The drag&drop area shall only accept draggables of a type defined in it. | Important | Completed |
| 7.4 | The draggable words in a drag&drop area shall inherit it's classified type. | Important | Completed |
| 7.5 | If the drag&drop area has no type defined, it shall only accept words that have no type defined. | Important | Completed |
| 7.6 | The test creator may specify the maximum amount of words to be contained in drag&drop area. | Important | Completed |
| 7.7 | Drag&drop area may contain copyable words. | Important | Completed |
| 7.8 | If defined by the test creator, the contained words in the drag&drop area shall be copied and copies shall be deleted when dropped outside any drag&drop area. | Important | Completed |
| 7.9 | The drag&drop area that has been specified to be a copy source shall have it's contained words copied. | Important | Completed |
| 7.10 | The drag&drop area that has been specified to be a copy target shall only accept dragged copied words. | Important | Completed |
| 7.11 | Drag&drop area may contain movable words. | Essential | Tested |
| 7.12 | The test creator may create a trashcan drag&drop area, which will delete movable words when they are dragged into it. | Important | Completed |
| 7.13 | Movable words shall not be deleted unless dragged to a trashcan drag&drop area. | Important | Completed |
| 7.14 | The drag&drop area may contain draggable images. | Possible | Completed |
| 7.15 | The test creator may classify a drag&drop area to hold words of a desired type. | Important | Completed |
9.3 Requirements for the dropdown plugin
| No. | Description | Priority | State |
|---|---|---|---|
| 8.1 | The dropdown list may be defined to be displayed as a list of radiobuttons by the test creator. | Possible | Completed |
| 8.2 | A dropdown answer shall be able to be saved independent from a feedback plugin. | Important | Completed |
| 8.3 | The content in the current dropdown selection may be chosen not be saved by the test creator when an answer to a dropdown list is saved to the database. | Possible | Completed |
| 8.4 | The dropdown selection shall be empty by default. | Essential | Tested |
| 8.5 | The learner shall choose one option in the dropdown when answering a question item. | Essential | Tested |
| 8.6 | One option from the dropdown list of the plugin shall be selected to be able to confirm an answer. | Important | Tested |
| 8.7 | The content in the dropdown list may be defined by the test creator when adding the plugin to a TIM document. | Important | Tested |
| 8.8 | The order the content in the dropdown list is in may be chosen to be randomized by the test creator. | Important | Completed |
| 8.9 | The plugin may receive the content in its dropdown list from a feedback plugin. | Important | Tested |
| 8.10 | The plugin shall return its currently selected item when requested by other plugins implementing the ITimComponent interface. | Important | Tested |
10. Requirements for adaptive feedback
The chapter describes the requirements related to adaptive feedback shown to the learner.
10.1 Requirements for the adaptive feedback plugin
| No. | Description | Priority | State |
|---|---|---|---|
| 9.1 | The plugin shall show the feedback linked to question items in the task to the learner. | Essential | Tested |
| 9.2 | The adaptive feedback level shall increase on every wrong answer of the learner. | Essential | Tested |
| 9.3 | The correctness of the learner's answer shall be checked in the server instead of the learner's browser. | Idea | Not Implemented |
| 9.4 | The correct answer to a question item in feedback shall have a match defined for every dropdown list in the question item. | Important | Completed |
| 9.5 | The correct answer to a question item in feedback shall have a match defined for every drag&drop area in the question item. | Important | Completed |
| 9.6 | A match for an answer of a plugin in a question item shall be a string of text. | Important | Completed |
| 9.7 | The next question item presented to the learner shall be selected at random from the question items that the learner has not yet answered. | Important | Completed |
| 9.8 | A question item that the learner has answered to incorrectly shall not be presented to them again during a task. | Important | Completed |
| 9.9 | The next question item presented to the learner may be selected at random from the question items that the learner has not yet answered correctly. | Discarded | Not Implemented |
| 9.10 | If the content to a question item is provided in feedback, the content shall be an array of text strings. | Important | Completed |
| 9.11 | If the content to a question item is provided in feedback, the content may be an array of tuples. | Idea | Not Implemented |
| 9.12 | A practice item may be defined for a feedback plugin in a TIM document. | Important | Completed |
| 9.13 | When hiding question items, feedback shall hide a TIM area instead of the question item if one is defined for the question item. | Important | Completed |
| 9.14 | A match for an answer of a plugin in a question item may be a regular expression. | Possible | Completed |
| 9.15 | The adaptive feedback level may decrease on correct answers if specified in the task. | Idea | Not Implemented |
10.2 Requirements for the adaptive feedback plugin interaction with the test creator
| No. | Description | Priority | State |
|---|---|---|---|
| 10.1 | The correct answer to every question item in the task shall be defined by the test creator. | Important | Tested |
| 10.2 | The test creator shall be able to define one or more levels of feedback to the wrong answers of a learner. | Essential | Tested |
| 10.3 | The test creator shall specify stopping conditions to stop a task. | Important | Tested |
| 10.4 | The lowest number of feedback levels for the question items defined by the test creator shall be a stopping condition. | Important | Completed |
| 10.5 | The number of consecutive correct answers shall be a stopping condition the test creator may specify. | Important | Tested |
| 10.6 | Default value for the number of consecutive answers as a stopping condition shall be used if one is not defined by the test creator. | Important | Completed |
| 10.7 | The test creator may specify the task to end based on Bayesian probability. | Discarded | Not Implemented |
| 10.8 | The words in a drag&drop area shall be reset if it is defined as a drag source in feedback by the test creator. | Important | Completed |
| 10.9 | The question items shall be presented consecutively instead of randomly to the learner if specified by the test creator. | Possible | Completed |
| 10.10 | The amount of points the learner receives by answering a question item may be defined by the test creator. | Possible | Completed |
| 10.11 | If points are not defined by the test creator, a default amount shall be given to the learner for an answer to a question item. | Possible | Completed |
| 10.12 | Consecutive incorrect answers defined by the test creator may be a stopping condition | Discarded | Not Implemented |
| 10.13 | A question item that the learner has answered to incorrectly may be presented to the learner again if specified by the test creator. | Idea | Not Implemented |
10.3 Requirements for saving user input in the adaptive feedback plugin
| No. | Description | Priority | State |
|---|---|---|---|
| 11.1 | The plugin shall save the feedback the learner was given when acknowledging the user input. | Essential | Tested |
| 11.2 | The plugin shall save the user's answer to the current question item when acknowledging the user input. | Essential | Tested |
| 11.3 | The plugin shall save the correctness of the learner's answer when acknowledging the user input. | Essential | Tested |
| 11.4 | The plugin shall save the correct answer to the current question item when acknowledging the user input. | Essential | Tested |
| 11.5 | The plugin shall save the points the learner received from the question item when acknowledging the user input. | Possible | Completed |
10.4 Requirements for displaying of errors in the adaptive feedback plugin
| No. | Description | Priority | State |
|---|---|---|---|
| 12.1 | An error shall be presented if an instruction TIM block is not found in the document. | Important | Tested |
| 12.2 | An error shall be presented if there are no question items defined in the task. | Important | Completed |
| 12.3 | An error shall be presented if a question item is missing a correct answer. | Important | Tested |
| 12.4 | An error shall be presented if the correct answer to a question item does not have a match defined for every dropdown list in the question item. | Important | Completed |
| 12.5 | An error shall be presented if a question item in feedback does not have any feedback levels defined in it. | Important | In TIM |
| 12.6 | An error shall be presented if the number of feedback levels between the question items of a task are not the same. | Important | Tested |
| 12.7 | An error shall be presented if a match for default feedback is not defined for a question item. | Important | Tested |
| 12.8 | An error shall be presented if the correct answer to a question item does not have a match defined for every drag&drop area in the question item. | Important | Completed |
| 12.9 | An error shall be presented if a question item has no dropdown or drag&drop plugins defined in it. | Important | Completed |
| 12.10 | An error shall be presented if a practice item is defined in feedback but not found from the document. | Important | Completed |
| 12.11 | A note to drag something to a drag&drop area shall be presented if the drag&drop area is empty when the learner confirms their answer. | Important | Tested |
| 12.12 | A note to select a choice shall be presented if no choice in the dropdown list is selected when the learner confirms their answer. | Important | Tested |
10.5 Requirements for adaptive feedback presentation
| No. | Description | Priority | State |
|---|---|---|---|
| 13.1 | The learner shall be presented adaptive feedback after they have confirmed their answer to a question item. | Essential | Tested |
| 13.2 | The feedback level the learner currently is in a task may be presented back to the learner when presenting feedback to the learner. | Idea | Not Implemented |
| 13.3 | The test creator may specify a position for the correct answer to the current question item when defining feedback to answers. | Important | Completed |
| 13.4 | The defined position of the correct answer to the current question item shall be replaced by the correct answer to the current question item when presenting feedback to the learner. | Important | Completed |
| 13.5 | The test creator may specify a position for one of the learner's selections to the current question item when defining feedback to answers. | Important | Completed |
| 13.6 | The defined position of one of the learner's selections to the current question item shall be replaced by learner's selections to the current question item when presenting feedback to the learner. | Important | Completed |
| 13.7 | The test creator may specify a position for parts of one of the learner's selections to the current question item when defining feedback to answers. | Important | Completed |
| 13.8 | The defined position of parts of one of the learner's selections to the current question item shall be replaced by learner's selections to the current question item when presenting feedback to the learner. | Important | Completed |
| 13.9 | The test creator may specify a position for the learner's answer to the current question item when defining feedback to answers. | Important | Tested |
| 13.10 | The defined position of the learner's answer to the current question item shall be replaced by learner's answer to the current question item when presenting feedback to the learner. | Important | Tested |
| 13.11 | The test creator may specify a position for parts of the learner's answer to the current question item when defining feedback to answers. | Important | Completed |
| 13.12 | The defined position of parts of the learner's answer to the current question item shall be replaced by learner's answer to the current question item when presenting feedback to the learner. | Important | Completed |
| 13.13 | The test creator may specify a position for part of the current question item when presenting feedback to the learner. | Important | Completed |
| 13.14 | The defined position of part of the current question item shall be shall be replaced by part of the current question item when presenting feedback to the learner. | Important | Completed |
11. Requirements for reports
The following chapters describe the requirements set for the report exporting.
11.1 Requirements for exporting reports
| No. | Description | Priority | State |
|---|---|---|---|
| 14.1 | An exporter shall be able to export a report of the test. | Essential | In TIM |
| 14.2 | The report shall only be possible to be exported when a feedback plugin is present on the TIM document page the report is requested from. | Idea | Not Implemented |
| 14.3 | The report shall be exported in CSV format. | Essential | Tested |
| 14.4 | The report shall be formed from information saved by question item plugins and feedback plugins the learners have interacted with during the test. | Essential | Tested |
| 14.5 | A line in the report shall contain data saved by the feedback plugin of one task in a single TIM document. | Important | Tested |
| 14.6 | A line of the report shall consist of a single answer by a learner to a question item of a task. | Important | Tested |
| 14.7 | The lines of the report shall be grouped by learners. | Important | Tested |
| 14.8 | The lines of the report may be grouped by the tasks of the test. | Idea | Not Implemented |
| 14.9 | A single answer in the report shall consist of the following data: learner's identifying information, question item presented, learner's answer, feedback received by the learner, time used to answer a question item and the time used reading feedback. | Important | Tested |
| 14.10 | A single answer in the report may contain the points earned for a question item. | Idea | Not Implemented |
11.2 Requirements for the report exporting window
| No. | Description | Priority | State |
|---|---|---|---|
| 15.1 | The data the report contains shall be selected in a report exporting window. | Important | Tested |
| 15.2 | The data included in the report shall be able to be selected by the exporter. | Important | Tested |
| 15.3 | The learners whose answers are included in the report shall be selectable. | Important | In TIM |
| 15.4 | The time period from which the answers in the report are gathered shall be able to defined by the exporter. | Important | Tested |
| 15.5 | The learners whose answers are included in the report may be chosen to be anonymized by the exporter. | Important | Tested |
| 15.6 | The delimiter used in the report shall be selectable. | Important | Tested |
| 15.7 | The desimal sign used in the report shall be selectable. | Important | Tested |
| 15.8 | The report may contain data from the whole test that consists of multiple TIM documents inside a TIM folder. | Important | Tested |
12. Fulfillment of requirements
The chapter describes the functionality developed in the TIMCAN project and the number and fulfillment of functional requirements as a whole as well as a summary by each feature.
12.1 Fulfillment of requirements as a whole
| State/Priority | Essential | Important | Possible | Idea | Discarded | Total |
|---|---|---|---|---|---|---|
| In TIM | 5 | 9 | 0 | 0 | 0 | 14 |
| Approved | 0 | 0 | 0 | 0 | 0 | 0 |
| Tested | 30 | 32 | 0 | 0 | 0 | 62 |
| Completed | 14 | 52 | 12 | 0 | 0 | 78 |
| Unfinished | 0 | 0 | 0 | 0 | 0 | 0 |
| Not Started | 0 | 0 | 0 | 0 | 0 | 0 |
| Not Implemented | 0 | 0 | 0 | 21 | 3 | 24 |
| Total | 49 | 93 | 12 | 21 | 3 | 178 |
12.2 Fulfillment of requirements by each feature
| State/Priority | Essential | Important | Possible | Idea | Discarded | Total |
|---|---|---|---|---|---|---|
| Creating a test | 3 | 6 | 0 | 5 | 0 | 14 |
| Creating a task | 7 | 2 | 1 | 0 | 0 | 10 |
| Test presentation | 9 | 4 | 3 | 2 | 0 | 18 |
| Test progression | 8 | 3 | 0 | 5 | 0 | 16 |
| All developed plugins | 5 | 3 | 0 | 0 | 0 | 8 |
| Drag&drop plugin | 1 | 8 | 0 | 1 | 0 | 10 |
| Interaction between drag&drop plugins | 3 | 11 | 1 | 0 | 0 | 15 |
| Dropdown plugin | 2 | 6 | 2 | 0 | 0 | 10 |
| Adaptive feedback plugin | 2 | 8 | 1 | 3 | 1 | 15 |
| Adaptive feedback plugin interaction with the test creator | 1 | 6 | 3 | 1 | 2 | 13 |
| Saving user input in the adaptive feedback plugin | 4 | 0 | 1 | 0 | 0 | 5 |
| Displaying of errors in the adaptive feedback plugin | 0 | 12 | 0 | 0 | 0 | 12 |
| Adaptive feedback presentation | 1 | 12 | 0 | 1 | 0 | 14 |
| Exporting reports | 3 | 4 | 0 | 3 | 0 | 10 |
| The report exporting window | 0 | 8 | 0 | 0 | 0 | 8 |
| Total | 49 | 93 | 12 | 21 | 3 | 178 |
References
[1] Hanna Alatalo, Jarkko Kuivanen, Elisa Nauha, Jere Ojanen and Kimmo Urtamo. TIMCAN-projektin projektisuunnitelma. https://tim.jyu.fi/view/kurssit/tie/proj/ 2019/timcan/dokumentit/projektisuunnitelma_timcan. University of Jyväskylä, Faculty of Information Technology. 2019.
[2] Hanna Alatalo, Jarkko Kuivanen, Elisa Nauha, Jere Ojanen and Kimmo Urtamo. TIMCAN-projektin projektiraportti. https://tim.jyu.fi/view/kurssit/tie/proj/ 2019/timcan/dokumentit/projektiraportti_timcan. University of Jyväskylä, Faculty of Information Technology. 2019.
[3] Hanna Alatalo, Jarkko Kuivanen, Elisa Nauha, Jere Ojanen and Kimmo Urtamo. Application Report of Project TIMCAN. https://tim.jyu.fi/view/kurssit/tie/proj/ 2019/timcan/dokumentit/application-report-of-project-timcan. University of Jyväskylä, Faculty of Information Technology. 2019.
[4] Hanna Alatalo, Jarkko Kuivanen, Elisa Nauha, Jere Ojanen and Kimmo Urtamo. User Manual for Creating Adaptive Feedback Test in the TIM. https://tim.jyu.fi/view/kurssit/tie/proj/ 2019/timcan/kayttoohjeet/instructions. University of Jyväskylä, Faculty of Information Technology. 2019.
[5] Hanna Alatalo, Jarkko Kuivanen, Elisa Nauha, Jere Ojanen and Kimmo Urtamo. Instructions on Future Development. https://tim.jyu.fi/view/kurssit/tie/proj/ 2019/timcan/kayttoohjeet/further-development. University of Jyväskylä, Faculty of Information Technology. 2019.
These are the current permissions for this document; please modify if needed. You can always modify these permissions from the manage page.