Requirements of Authoring Tasks

Target release	Phase 1
Epic
Document status	DRAFT
Document owner	Rory Davidson
Analyst	Emily Wang
Designer
Developers
QA

Goals

Enable authors to work based on tasks, for the tasks to be reviewed, and for the tasks to be promoted into a project, ready for release

Assumptions

A task represents a work task
A task is represented as a JIRA ticket within a specific project
This task is also represented as a task branch on the terminology server
A task can be linked to one or many SIRS (or equivalent) requests

Requirements

#	Title	Requirement Description	User Story	Sprint	Notes	JIRA Tickets
1	Creation of a task	It must allow to create a task by project lead assign the task to an author define task title, project name, and description of the task notify the author whom has been assigned the ticket	As an author lead, I want to create a work task and assign to an author so that author can receive a task from author lead directly.	4	A JIRA ticket would be created on the specific project to represent the task	Create a task by project lead in Jira
2	Creation of a task	It must enable to create a task by author define task title, project name, and description of the task save the task (into TS and Jira).	As an author, I want to create my own task to deal with some content I have been asked to edit or create so that I can provide summary of my task.	1	A JIRA ticket would be created on the specific project to represent the task	WRP-495 - Getting issue details... STATUS WRP-496 - Getting issue details... STATUS WRP-497 - Getting issue details... STATUS
3	Adding content to a task	It should require author to provide free text. For example request IDs, summary of each request, and manager of that request in the description of the task. Note: this requirement is only for minimum viable product but not the final delivery.	As an author, I want to work within a task and have the work I have done tracked for future reference	2	All editing during the context of the task should be audited and retrievable against the task	Require author to provide information
4	Adding content to a task from a file	It should allow author to upload a list of request IDs as a file into task. Note: this requirement is only for minimum viable product in phase 1.	As an author, I want to import a list of request IDs as a file to create the worklist within the task	3		A button to load file into task Able to open the uploaded file from task
5	Changing status of a task	It must be able to change status from 'New' to 'In progress' when author start working on a task in SCAT change status from 'In progress' to 'Peer Review' when author is ready to submit for review Change status from 'Peer Review' back to "In Progress" when a reviewer needs further work to be done change status from 'Peer Review' to 'Ready for promotion' when review is completed and all contents are approved change status from 'Ready for promotion' to 'Promoted' when author promoted a task to project level. change status from 'Promoted' to 'Completed' when a task is promoted to project and has no conflict with other tasks in the project	As an author, I want to change status of task so that I can move forward my task to the next state.	2		Update the status of the task from 'New' to 'In progress' when author open the task in the SCAT. Update the status of task to "Peer Review" after click the button 'Ready for review' Allow author to assign the task to a reviewer after click the button 'Ready for review' Update the status of task to "Ready for promotion" after reviewer approved the task Allow reviewer to assign the task back to the author when the task is 'Ready for promotion' Update the status of task to "promoted" when a task has been promoted to project. Update the status of task to "completed" after project is promoted to project and the task has no conflict with other task in the project
6	Notifying user when a task is assigned to him/her by other user	It must notify a reviewer when a task is ready for review and assign to them notify an author when his/her task is 'ready for promotion' notify project lead when a task is promoted to project	As an author, I want to be notified when a task is assigned to me	3		notify the reviewer when a task is assigned to him/her for review notify the author when his/her task is 'ready for promotion' notify the project lead when a task is in status 'Promoted' in his/her project notify the author when his/her task is 'completed'
7	Notifying user when any request in task has been modified	It must notify user when any requests in task has been modified in request management tool	As an author, I want to be notified immediately when a request in my task has been modified so that I can have the latest information for authoring.	6
8	Searching a task on dashboard	It must be able to search a task on dashboard by any column or text search	As an author, I want to search task by title of task assigned to me reported by me project name status of task text search (specify the fields in tasks that I want to search for)	2		search in a text search box ascending/descending alphabet search of each column

Workflow of task

New: when a task is created by author, it will be in this state.

In progress: when an author starts working on a new task, it will enter this state. When classification is failed because of classification errors, it will come back to this state from 'Classification'. When classification is completed with no errors but author modifies any concepts have been classification, it will come back to this state from 'Classification' and author has to classify the task again. When reviewing is completed by an reviewer but it has errors in the task, it will come back to this state from 'Peer review'.

Classification: when an author clicks the 'Classify' button, it will enter this state.

Peer review: when an author clicks the 'Ready for review' button, it will enter this state. The authors with reviewing role will see this task in the 'Review Tasks' list on the dashboard.

Escalation: when editing author and reviewing author have different opinions in a task, it will enter this state. Authoring team will discuss the issues in this task and provide a final decision.

Ready for promotion: when a task is reviewed by reviewer and there is no need to make any changes in this task, it will enter this state.

Promoted to project: when a task is promoted to the project level in TS, it will enter this state.

Completed: when the task promoted to the project level has no conflict and author is ready to close the task, it will enter this state.

Pending answer: when an author has to clarify a request or put a request on hold, it will enter this state. After a certain time (need to be defined by authoring team), if author cannot get response from requestor, then author will remove that request from the task. The status of the task will be changed to 'In progress' then.

Questions

Below is a list of questions to be addressed as a result of this requirements document:

Question	Outcome

Not Doing

A JIRA ticket per concept

Page tree