From d4ba908e426f260cbd24c72a0875857cb557b4de Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 22 Apr 2020 13:43:25 +0200 Subject: eng: Update requirements engineering chapter Update requirements engineering chapter due to the removal of Doorstop as the requirements management tool. Update the application configuration related specification items. Update #3715. --- images/eng/req-add.pdf | Bin 81320 -> 88918 bytes images/eng/req-add.png | Bin 50516 -> 50450 bytes images/eng/req-add.puml | 21 +++++++++++---------- images/eng/req-modify.pdf | Bin 68500 -> 69574 bytes images/eng/req-modify.png | Bin 37776 -> 38311 bytes images/eng/req-modify.puml | 14 +++++++------- 6 files changed, 18 insertions(+), 17 deletions(-) (limited to 'images') diff --git a/images/eng/req-add.pdf b/images/eng/req-add.pdf index eb4e8e8..81205f8 100644 Binary files a/images/eng/req-add.pdf and b/images/eng/req-add.pdf differ diff --git a/images/eng/req-add.png b/images/eng/req-add.png index 89346bd..df083d0 100644 Binary files a/images/eng/req-add.png and b/images/eng/req-add.png differ diff --git a/images/eng/req-add.puml b/images/eng/req-add.puml index 52b01f0..46eb115 100644 --- a/images/eng/req-add.puml +++ b/images/eng/req-add.puml @@ -1,29 +1,30 @@ ' SPDX-License-Identifier: CC-BY-SA-4.0 -' Copyright (C) 2019 embedded brains GmbH +' Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de) @startuml start -:Invoke: ""doorstop add RTEMS""; +:Create file: ""spec/component/new.yml""; note right - This will create a new requirement. - For this activity its UID shall be NEW. - It is located in a file NEW.yml. + Create a new file in the specification + directory. For this activity its UID + shall be spec:/component/new. It is + located in the file spec/component/new.yml. end note while (Needs a link to a parent requirement?) is (Yes) - :Invoke: ""doorstop link NEW PARENT""; + :Add link to links attribute of file: ""spec/component/new.yml""; endwhile (No) repeat - :Invoke: ""doorstop edit NEW""; + :Edit file: ""spec/component/new.yml""; - :Edit the requirement according to your needs and save it; + :Add attributes according to your needs and save the file; - :Commit NEW.yml with a proper message; + :Commit the changes with a proper message; :Send the patch to the devel@rtems.org mailing list for review; repeat while (Reviewers demand changes in the new requirement?) is (Yes) @@ -32,7 +33,7 @@ repeat while (Reviewers demand changes in the new requirement?) is (Yes) if (New requirement was accepted by reviewers?) then (Yes) :Push the commit to the project repository; else (No) - :Discard the NEW requirement; + :Discard the new requirement; endif stop diff --git a/images/eng/req-modify.pdf b/images/eng/req-modify.pdf index a1a501a..a4a8a10 100644 Binary files a/images/eng/req-modify.pdf and b/images/eng/req-modify.pdf differ diff --git a/images/eng/req-modify.png b/images/eng/req-modify.png index 8685e4d..8dd8eb4 100644 Binary files a/images/eng/req-modify.png and b/images/eng/req-modify.png differ diff --git a/images/eng/req-modify.puml b/images/eng/req-modify.puml index cb104a6..fd5a400 100644 --- a/images/eng/req-modify.puml +++ b/images/eng/req-modify.puml @@ -1,23 +1,23 @@ ' SPDX-License-Identifier: CC-BY-SA-4.0 -' Copyright (C) 2019 embedded brains GmbH +' Copyright (C) 2019, 2020 embedded brains GmbH (http://www.embedded-brains.de) @startuml start repeat - :Invoke: ""doorstop edit REQ""; + :Edit: ""spec/component/req.yml""; note right - For this activity the UID - of the requirement shall be REQ. - It is located in a file REQ.yml. + For this activity the UID of the + requirement shall be spec:/component/req. + It is located in a file spec/component/req.yml. end note - :Edit the requirement according to your needs and save it; + :Edit the attributes according to your needs and save the file; - :Commit REQ.yml with a proper message; + :Commit the changes with a proper message; :Send the patch to the devel@rtems.org mailing list for review; repeat while (Reviewers demand changes in the modified requirement?) is (Yes) -- cgit v1.2.3