Add the requirements document (#5)

* Add the first revision of the ROS2 Navigation System requirements document.
ros-navigation · Jul 12, 2018 · e61be13 · e61be13
1 parent fa9adfa
commit e61be13
Show file tree

Hide file tree

Showing 26 changed files with 343 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Navigation2
 
-ROS2 Navigation
+ROS2 Navigation System
 
 # Overview
-The ROS2 Navigation system is the central control system for a robot to autonomously move to a given location on a map. Given a current pose, a map and a destination, the system uses sensor input to localize the robot on the map, generates a plan to reach the destination, and outputs commands to drive a robot to that location. It will also autonomously avoid obstacles and re-plan if needed to bypass them.
+The ROS 2 Navigation System is the control system that enables a robot to autonomously reach a goal state, such as a specific position and orientation relative to a specific map. Given a current pose, a map, and a goal, such as a destination pose, the navigation system generates a plan to reach the goal, and outputs commands to autonomously drive the robot, respecting any safety constraints and avoiding obstacles encountered along the way.
 
 # Contributing
-Currently we are in the design phase, and are accepting input and requirements. To contribute, see the [design README.md](design/README.md)
+We are currently in the requirements analysis phase, and are accepting input and requirements. To contribute, see the [documentation README](doc/README.md).
diff --git a/design/README.md b/design/README.md
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,8 @@
+# ROS2 Navigation System Documentation
+This is where the ROS2 Navigation System documentation is being collected and vetted.
+
+# Requirements
+See the [requirements document](requirements/requirements.md) for the current list of requirements.
+
+# Contributing
+To propose additions or changes to the requirements, please file an issue against the requirements document to initiate a discussion of the topic. Then, once the discussion has completed and the group has agreed to move forward on the item, you can submit a pull request and link to the issue.
diff --git a/doc/images/ros2-logo.png b/doc/images/ros2-logo.png
diff --git a/design/requirements/_template_requirement.md → doc/requirements/_template_requirement.md b/design/requirements/_template_requirement.md → doc/requirements/_template_requirement.md
diff --git a/doc/requirements/images/Command-Pipeline-Support.png b/doc/requirements/images/Command-Pipeline-Support.png
diff --git a/doc/requirements/images/Command-Pipeline.png b/doc/requirements/images/Command-Pipeline.png
diff --git a/doc/requirements/images/Command-Pipeline.vsdx b/doc/requirements/images/Command-Pipeline.vsdx
diff --git a/doc/requirements/images/Context.png b/doc/requirements/images/Context.png
diff --git a/doc/requirements/images/Mapping-Use-Cases.png b/doc/requirements/images/Mapping-Use-Cases.png
diff --git a/doc/requirements/images/Mission-Execution-Use-Cases.png b/doc/requirements/images/Mission-Execution-Use-Cases.png
diff --git a/doc/requirements/images/Mission-Planning-Use-Cases.png b/doc/requirements/images/Mission-Planning-Use-Cases.png
diff --git a/doc/requirements/images/Navigation-System.png b/doc/requirements/images/Navigation-System.png
diff --git a/doc/requirements/images/With-Support-Modules.png b/doc/requirements/images/With-Support-Modules.png
diff --git a/doc/requirements/requirements.md b/doc/requirements/requirements.md
diff --git a/design/use_cases/_template_use_case.md → doc/use_cases/_template_use_case.md b/design/use_cases/_template_use_case.md → doc/use_cases/_template_use_case.md
diff --git a/...use_cases/collision_avoidance_use_case.md → ...use_cases/collision_avoidance_use_case.md b/...use_cases/collision_avoidance_use_case.md → ...use_cases/collision_avoidance_use_case.md
diff --git a/...use_cases/indoor_localization_use_case.md → ...use_cases/indoor_localization_use_case.md b/...use_cases/indoor_localization_use_case.md → ...use_cases/indoor_localization_use_case.md
diff --git a/...n/use_cases/indoor_navigation_use_case.md → doc/use_cases/indoor_navigation_use_case.md b/...n/use_cases/indoor_navigation_use_case.md → doc/use_cases/indoor_navigation_use_case.md
diff --git a/design/use_cases/keep_out_zones_use_case.md → doc/use_cases/keep_out_zones_use_case.md b/design/use_cases/keep_out_zones_use_case.md → doc/use_cases/keep_out_zones_use_case.md
diff --git a/...se_cases/multi-story-building_use_case.md → ...se_cases/multi-story-building_use_case.md b/...se_cases/multi-story-building_use_case.md → ...se_cases/multi-story-building_use_case.md
diff --git a/...se_cases/outdoor_localization_use_case.md → ...se_cases/outdoor_localization_use_case.md b/...se_cases/outdoor_localization_use_case.md → ...se_cases/outdoor_localization_use_case.md
diff --git a/.../use_cases/outdoor_navigation_use_case.md → doc/use_cases/outdoor_navigation_use_case.md b/.../use_cases/outdoor_navigation_use_case.md → doc/use_cases/outdoor_navigation_use_case.md
diff --git a/include/.gitignore b/include/.gitignore
diff --git a/src/.gitignore b/src/.gitignore
diff --git a/test/.gitignore b/test/.gitignore