From 176ce075f6f80813cd0dee1355d2268212f0b1d9 Mon Sep 17 00:00:00 2001 From: Matthew Hansen Date: Mon, 4 Jun 2018 13:50:29 -0700 Subject: [PATCH 1/9] Added use case template --- design/use_cases/_template_use_case.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 design/use_cases/_template_use_case.md diff --git a/design/use_cases/_template_use_case.md b/design/use_cases/_template_use_case.md new file mode 100644 index 0000000000..17b86d2ad9 --- /dev/null +++ b/design/use_cases/_template_use_case.md @@ -0,0 +1,16 @@ +# Use case Title +As a I want the robot to so that can + +## More details +- Why is this needed? +- What is the expected user interaction? + + +#Example: + +# Warehouse Navigation +As a warehouse robot operator, I want the robot to navigate without colliding into people or objects so that it doesn't hurt anyone or damage anything + +## More details + - I want this so that I know the robot won't damage itself, damage property or hurt anyone + - I shouldn't have to interact with the robot to prevent it from crashing into people or things From 1fed2a5bf2be28616f756012fee90b229551652a Mon Sep 17 00:00:00 2001 From: Matthew Hansen Date: Mon, 4 Jun 2018 13:59:45 -0700 Subject: [PATCH 2/9] Added requirement template --- design/requirements/_template_requirement.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 design/requirements/_template_requirement.md diff --git a/design/requirements/_template_requirement.md b/design/requirements/_template_requirement.md new file mode 100644 index 0000000000..70184f2688 --- /dev/null +++ b/design/requirements/_template_requirement.md @@ -0,0 +1,18 @@ +# Requirement Title +The should be able to + +## More details +- Why is this needed? +- What is the expected user interaction? +- What use case does this map to? + + +#Example: + +# Warehouse Navigation +The navigation system should include a modular collision avoidance algorithm that can be replaced with a new algorithm at run time + +## More details + - I want to be able to write or use my own collision avoidance algorithm without having to re-compile the entire stack from source + - Ideally I can just change out a node using a custom launch file + - This maps to the "Collision avoidance" use case From 24dc81211c6dbe3f60869cbe4ae20120e47253df Mon Sep 17 00:00:00 2001 From: Matthew Hansen Date: Mon, 4 Jun 2018 14:08:24 -0700 Subject: [PATCH 3/9] Added README.md for design docs --- design/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 design/README.md diff --git a/design/README.md b/design/README.md new file mode 100644 index 0000000000..8fe2bf78d4 --- /dev/null +++ b/design/README.md @@ -0,0 +1,15 @@ +# ROS2 Navigation Design documenation +This is where the ROS2 Navigation design documentation is being collected and vetted + +# Use Cases +These are for defining how the user interacts with the system + +See the [use case template](use_cases/_template_use_case.md) + +# Requirements +These are for defining the technical requirements + +See the [requirement template](requirements/_template_requirement.md) + +# Contributing +To submit a request for a use case or requirement, copy and modify the template and submit a pull request for review From 30288c9def6fbb9facad97f54bdc0267ae0f52af Mon Sep 17 00:00:00 2001 From: Matthew Hansen Date: Mon, 4 Jun 2018 14:27:23 -0700 Subject: [PATCH 4/9] Update readme for design contributions --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index b4a5f53e1b..7fc596dcc9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ # navigation2 ROS2 navigation + +# Contributing +Currently we are in the design phase, and are accepting input and requirements. To contribute, see the [design README.md](design/README.md) From a654fbc7c9c24c38b277833e0c98573687d6de6c Mon Sep 17 00:00:00 2001 From: Matt Hansen Date: Tue, 5 Jun 2018 14:40:34 -0700 Subject: [PATCH 5/9] Update README.md to capitalize Navigation --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7fc596dcc9..9a54b46ea4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# navigation2 +# Navigation2 -ROS2 navigation +ROS2 Navigation # Contributing Currently we are in the design phase, and are accepting input and requirements. To contribute, see the [design README.md](design/README.md) From 1fdd7e5152c88f91837cb880c0f9cf300c08faf3 Mon Sep 17 00:00:00 2001 From: Matt Hansen Date: Tue, 5 Jun 2018 14:43:56 -0700 Subject: [PATCH 6/9] Fix typo and capitalization --- design/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design/README.md b/design/README.md index 8fe2bf78d4..1ad42a5435 100644 --- a/design/README.md +++ b/design/README.md @@ -1,4 +1,4 @@ -# ROS2 Navigation Design documenation +# ROS2 Navigation design documentation This is where the ROS2 Navigation design documentation is being collected and vetted # Use Cases From cafe03b4a0883ccc8ffbeb30ed393edb836e45ad Mon Sep 17 00:00:00 2001 From: Matt Hansen Date: Tue, 5 Jun 2018 14:50:37 -0700 Subject: [PATCH 7/9] Add escape before brackets and fix Example markup --- design/requirements/_template_requirement.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/design/requirements/_template_requirement.md b/design/requirements/_template_requirement.md index 70184f2688..ccde8a0fc4 100644 --- a/design/requirements/_template_requirement.md +++ b/design/requirements/_template_requirement.md @@ -1,5 +1,5 @@ # Requirement Title -The should be able to +The \ should be able to \ \ ## More details - Why is this needed? @@ -7,7 +7,7 @@ The should be able to - What use case does this map to? -#Example: +# Example: # Warehouse Navigation The navigation system should include a modular collision avoidance algorithm that can be replaced with a new algorithm at run time From 0d059fcaefc67047dac9355cbd9dcf0febf9aafa Mon Sep 17 00:00:00 2001 From: Matt Hansen Date: Tue, 5 Jun 2018 14:55:04 -0700 Subject: [PATCH 8/9] Add non-functional reqs and consistent capitalization --- design/requirements/_template_requirement.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/design/requirements/_template_requirement.md b/design/requirements/_template_requirement.md index ccde8a0fc4..6b751e1392 100644 --- a/design/requirements/_template_requirement.md +++ b/design/requirements/_template_requirement.md @@ -5,6 +5,7 @@ The \ should be able to \ \ - Why is this needed? - What is the expected user interaction? - What use case does this map to? +- Are there any non-functional requirements (build system, tools, performance, etc) # Example: @@ -15,4 +16,4 @@ The navigation system should include a modular collision avoidance algorithm tha ## More details - I want to be able to write or use my own collision avoidance algorithm without having to re-compile the entire stack from source - Ideally I can just change out a node using a custom launch file - - This maps to the "Collision avoidance" use case + - This maps to the "Collision Avoidance" use case From ff3df8b8448b75a6313ae34ddf2a143517c12d9a Mon Sep 17 00:00:00 2001 From: Matt Hansen Date: Tue, 5 Jun 2018 14:58:44 -0700 Subject: [PATCH 9/9] Fix title, escape bracket, add non-functional reqs --- design/use_cases/_template_use_case.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/design/use_cases/_template_use_case.md b/design/use_cases/_template_use_case.md index 17b86d2ad9..3ac20b9897 100644 --- a/design/use_cases/_template_use_case.md +++ b/design/use_cases/_template_use_case.md @@ -1,12 +1,12 @@ -# Use case Title -As a I want the robot to so that can +# Use Case Title +As a \ I want the robot to \ so that \ can \ ## More details - Why is this needed? - What is the expected user interaction? +- Are there any non-functional requirements? (build system, tools, performance, etc) - -#Example: +# Example: # Warehouse Navigation As a warehouse robot operator, I want the robot to navigate without colliding into people or objects so that it doesn't hurt anyone or damage anything