i-adopt / users_stories

This repository is used to collate and discuss users stories submitted to the group
1 stars 3 forks source link

TASK 1: Collection of users stories

This repository relates to Task 1 of the I-ADOPT workplan. It is used to collate and discuss users stories submitted to the group. An I-ADOPT user story is a short and simple description of an application which requires semantic descriptions of observable properties.

A user story should be fundamentally a one-sentence description of what a particular type of user wants the solution to achieve, and why they want that. We are expanding the concept to include more complete narratives that can more fully explain your one-sentence user story.

Instructions

To initiate a user story, Get Started. (If there is some problem, go to the Issues tab for the repository, click New issue, then click on Get Started using the "User story submission template".)

If you just want to create a regular ticket that isn't a user story, then Open a blank issue.

Filling out the name

The ideal name is quite short, unique, and makes it easy to find your user story. If you can replace the each component of the suggested title (Role, Desired Action, and Benefit) with one or two words to uniquely define your story, that's recommended. If not, make the title whatever you think will help you and others find it.

Filling out the template

There are five sections. In the first three sections, replace the one-line description with a single phrase to complete that part. Remember that the user story is read by putting the first three sections together, so short phrases are most helpful.

The fourth section helps us categorize the user story, and can be a few keywords reflecting the research domain to which your user story applies. (Feel free to provide IRIs from controlled vocabularies here. :-) )

Look at some of the other user stories for inspiration, and remember that you have a section at the end into which you can add all the details that help define your complete user story.

Submission and Editing

Be sure to submit your user story using the Submit new issue button at the very bottom of the page.

You can go back and edit your story at any time by visiting it (while logged in to GitHub), clicking on the ... icon at the upper right of your story and selecting Edit from the context menu. After you are finished, make sure to hit the Update comment button to save your changes.

If you save an incomplete story, put (Incomplete) in the title so readers know you are still working on it.