-
Notifications
You must be signed in to change notification settings - Fork 0
Developers requirements
This is a document with a narrative overview of the development of the underlying components of the Community Orcid Dashboard. The overall requirements are in the Dashboard Requirements Document
These user stories hope to distil the overarching story into smaller stories, which are more workable. I’d suggest everybody first comes together to help design the API, and an overview of what will be involved with the abstract layer, likely before the hackday even begins. Then all other stories ought to be workable simultaneously on the day (in theory).
As a developer on this project
- I want to design an API which exposes the data from our abstraction layer to the public in some way (importantly for a given member of a given institution, we want the API to be able to tell us whether that user has or has not registered for an ORCID id)
- So that I can get started working on the presumption of the design of this API, and work on everything else in tandem
- I want to map out how connectors and facilitation functions will work within our abstract layer in order to properly develop the API
- So that I can get started working on various specific connectors and facilitation classes within the abstract layer immediately
As a developer on this project
- I want to design an abstraction layer which integrates with existing APIs and databases (ORCID itself, CRISs, Repositories, etc..) via a series of connectors
- So that it can be used as a source for our API
- Collaborative document on requirements https://docs.google.com/document/d/1xcbbEpBTLC-97QNPYyeu68bdaioH0h-CWMo-is5mCeM/edit?usp=sharing
I want to realise the vision described in the "Jisc Abstract Layer - An Overview" document
**NOTE: ** this is a substantial story in its own right and requires refinement (dependent upon design) to a more granular specification
As a developer hoping to create a platform which utilizes this data set
- I want to be able to access data on whether a given member of my institution is or is not registered for an ORCID id via an API
- So that I can easily create platforms which use this API
As a developer on this project:
- I want to use our API to build a dashboard which shows a user which members of their institution are or are not registered for an ORCID id
- So that we can complete this project
- I want this simple dashboard to include a downloadable CSV report on which members of my institution have registered for more than one ORCID id, which includes a list of their extraneous ORCIDs
- So that I can help these members to merge these records into one
From Google Doc