Create user story template for gathering industrial requirements

ros-industrial / ros_industrial_issues

Repository for tracking common ROS-Industrial issuses.

3 stars 4 forks source link

Create user story template for gathering industrial requirements #76

Open hellantos opened 2 years ago

hellantos commented 2 years ago

[x] Create a test repository for user stories
[x] Research available methodologies
[x] Create a template for user stories
[x] Add the first user stories from local storage
[ ] Move to ROS-I consortium once reviewed

hellantos commented 2 years ago

@gavanderhoorn @robinsonmm I have created a short preview of a possible template. https://github.com/ipa-cmh/ros_i_user_stories

It is based on agile user stories, but I added a more dedicated description of the user and his industrial problem/use case, so we know where the story comes from.

What do you think about it?

gavanderhoorn commented 2 years ago

Looks OK.

High level comment: any time there is the option to list multiple items (such as for User type), I'd suggest using an actual list, or use comma separation. Or change markup such that robotics end-user and the other options are clearly distinguishable from the "and". It's not easy right now to scan the file.

Did you also want to create something to capture missing features / functionality / problems?

hellantos commented 2 years ago

High level comment: any time there is the option to list multiple items (such as for User type), I'd suggest using an actual list, or use comma separation. Or change markup such that robotics end-user and the other options are clearly distinguishable from the "and". It's not easy right now to scan the file.

Good point on machine processing.

Did you also want to create something to capture missing features / functionality / problems?

I suppose we could have a list of necessary technologies/features/functionalities for the user stories.

gavanderhoorn commented 2 years ago

We could consider using a YAML based format for this. Example: robust-rosin/robust/kobuki/03660af/03660af.bug.

It wouldn't need to be this extensively structured or complex, but YAML is still human readable, allows free-form text (in certain special fields) and would make this immediately machine readable.