Requirements for Outreach Portal

[travula]

The Requirements for the outreach portal are gathered at a single location.

[travula]

Review of requirements done on 24/6/2016.

Review Comments: From Thirumal's notes

1. Requirements, section 1, with some blurb
2. Numbering and description, short titles and description.
3. occ in small letters.
4. 3.3 section, delete in upper case. update attributes. Make requirements as explicit as possible.
5. Traceability of the requirements.
6. 3.3, 3, reviewers can add comments, a note should be made
7. Institute has to be defined.
8. A new role National outreach co-ordinator creates users, assign occ(oc), create outreach centers and set targets.
9. An occ(oc) can add users and assign role.
10. 5.4, users associated
11. Activities or events
12. 6.2 co-ordinator.
13. Create an FAQ
    • Ensure Admin is part of the system.

From Priya's notes

1. Remove unfinished sections
2. Remove Req1/2/3 and add Short titles in section 2 and 3
3. Define OCC and NCC,Institutes in Section 3 ( glossary)
4. Should be able to hyperlink to a requirement have a FAQ section with list of axiom questions
5. Section 3
6. 3.3 : Define what an admin can do and cannot do ( delete user who is logged in ?). Make requirements as explicit as possible.
7. 3.3 : Req 3 : 3.1 : Add action of a reviewer ( may be alter releases)
8. 3.3 : Req 3 : 4.3: OCC can create user and can only assign NCC role
9. National Outreach Coordinator : sets target for OC
10. OCC set targets to NC and creates NCC and assigns targets to him.
11. OCC can create users and assign OCC role can create OC ( can manage all that he has created)
12. Institute - Admin,NOC,OCC and NC can create an institute.
13. Institute can be host to only one OC and one NC at a time.
14. Add other axioms defined in the Data model
15. Section 5, Req 4 : change coordinator to nodal coordinator or outreach coordinator
16. hyperlinking to activities / Event
17. Section 6 - 6.2 Req 3number of participants is an attribute to the Event. Change coordinator to nodal coordinator

Ian's Notes

1. building "an" outreach portal- correction to title
2. remove or edit empty sections
3. remove full stop unecessary--titles
4. add blurb description after heading
5. add description to paragraph in requirements
6. add description for roles in requirements, describe OCC, NCC, oc and nc
7. write 'delete' with an uppercase D in requirements
8. change 'information' to 'attributes'
9. make point 1, req 3 of Roles more explicit, admin cannot delete a logged in user
10. add hyperlink to individual requirements
11. add note to reviewer
12. add institute definition
13. new role->National Outreach Coordinator
14. add documentation--->> OCC can create a user
15. ncc should also create institute
16. change req 4 of NC, make more precise, change to 'users'
17. hyperlinks for activities
18. 6.2 req 3- change to nodal-coordinator
19. add institute section to requirements
20. 6.3 req 3 specify usage

[priya100raman]

Could you please include the link pointing to the latest Requirement document ?

https://github.com/vlead/outreach-portal-3.0/blob/objects-with-templates/src/requirements/index.org

[travula]

Minutes from the review meeting on requirements:

1. Institute entity to be added.
2. Traceability of the requirements to data-model to be done.
3. A new role national outreach coordinator to be added.
4. Each requirement to have short heading.

[travula]

Requirements from the meeting held with Sanjeet also to be captured. Section METHODOLOGY FOR COLLECTING OUTREACH USAGE DATA https://drive.google.com/drive/u/2/folders/0B0V6lgtnnIOZaWRJYm51emdtNVE

From Priya's notes: On methodology for collecting Outreach Usage Data:

1. of Virtual Labs experiment performed in the Nodal Centres = # of students * # of experiments. We might need to add another event/activity to Outreach Portal 3.0 to accommodate for the 'through out the semester' activity.

2. Online Lab-wise usage form : This is the feedback form submitted by the user. This would be implemented by integrating with the feedback service.

3. of attendees in workshops: Already existing as # of participants.

4. Cloud data usage : This would work when we have analytics ready as part of moving to edX. Every Outreach coordinator and Nodal Coordinator will fill electronic forms with above information and upload supporting documents to defend the numbers.

Some more requirements:

1. Without login one should be able to see all upcoming workshops and nodal centers.
2. Break up of all usages on dashboard : per institute.
3. Modifying an approved workshop should probably take the workshop to non approved state in Outreach Portal 3.0. However Mr Sanjeet wants workshops to go to approved status even without reports/feedback getting uploaded.

[travula]

Provide an edit log like commit message for every edit or delete. A mechanism for viewing all the logs should also be provided.