Requirements - shescoding/resource-annotation-wizard GitHub Wiki

Phase 1:

Goal(s):

The first iteration of the resource annotation wizard should make it easy for volunteers to process accumulated content to be added to the Resources section of the site. In the future, this should be a part of the main site and could be used to add new resources as they come up.

• Upload already annotated resources in a CSV format
• Upload multiple non-annotated URLs in a CSV format
• Complete resource annotations (full or partial)

Key Elements:

Any fields should be pre-populated with data if data is available in the spreadsheet.

• Upload CSV Allows the annotator to upload annotated resources in a CSV
• Upload URLs Allows the annotator to upload a number of URLs in CSV format for later annotation
• Resource Preview Displays the resource in an iframe
• Open in New Window/Tab For mobile devices & smaller screen sizes
• Title Input Title of the resource
• Source Input Relevant to publications?
• Description Input Short description of the resource
• Category Input Resource must be filed under one or more categories
• Tag Input No tag limit. Autocomplete is key to task completion speed, avoiding duplicates & spelling errors
• Date Input Relevant to publications
• Submit Resource Marks resource annotation as complete
• Report Issues Allows for the resource to be flagged If resource the down or no longer available for some reason.
• Skip Resource Load a random new resource if annotator would like to skip over a resource

Questions:

• For Upload CSV & URLs: How should success, failure and processing time be handled/displayed?

Future Phases

Not Doing (yet):

• Download CSV Allows the annotator to download a CSV of fully annotated resources. Will be added if needed.
• Individual URL annotation
• Add new URLs
• Automatic data fetching
• User profiles & authentication
• Resource manager
• How-To guide