search

uulm-smart-sensing / documentation

0 stars 0 forks source link

Resolve "add section about RE to wiki" - [merged] #69

Closed fgardt closed 1 year ago

fgardt commented 1 year ago

In GitLab by @mm1398 on May 29, 2023, 20:16

Merges docs/24-add-section-about-re-to-wiki -> master

What this MR does / why we need it:

Make sure that you've checked the box below before you submit MR:

Which platform/language

Which issue this MR fixes (optional)

CHANGELOG/Release Notes (optional)

*For more information check out the wiki : https://gitlab.uni-ulm.de/groups/se-anwendungsprojekt-22-23/-/wikis/Convention#documentation

Closes #24

fgardt commented 1 year ago

In GitLab by @mm1398 on May 30, 2023, 15:53

added 2 commits

Compare with previous version

fgardt commented 1 year ago

In GitLab by @mm1398 on May 30, 2023, 16:00

added 1 commit

Compare with previous version

fgardt commented 1 year ago

In GitLab by @mm1398 on May 31, 2023, 12:50

requested review from @group_1733_bot and @Merseleo

fgardt commented 1 year ago

In GitLab by @group_1733_bot on May 31, 2023, 13:56

added 1 commit

Compare with previous version

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 1, 2023, 12:18

removed review request for @group_1733_bot

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 1, 2023, 14:21

added 2 commits

Compare with previous version

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 1, 2023, 14:32

added 1 commit

Compare with previous version

fgardt commented 1 year ago

In GitLab by @group_1733_bot on Jun 1, 2023, 14:36

added 1 commit

Compare with previous version

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 34

The User Manual is a guide to help users use the library and demo app effectively. It contains important information on the following topics:
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 40

Why on "software design"?

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 47

For more information about the requirements of this project, see the [Software Requirement Document](./Software%20requirements%20document/SRD.pdf).
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 44

I don't understand what do you want to say here.

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 51

"into the implementation ..." I guess not, because we do not describe the implementation there.

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 57

The user story map is a visual representation of the requirements and functions from the user's point of view. It shows the different user stories and their prioritization. The user story map helps to get a comprehensive overview of the requirements and their relationships to each other.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 59

For more information on the user story map, see the [User Story Map document](./User%20Story%20Map/User%20Story%20Map.pdf).
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 70

    The document also covers the decision making behind adding or removing user stories or features. It explains what factors are considered when evaluating and prioritizing requirements and how decisions are made to make the best use of project scope and resources.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 77

Why in German?

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 90

The mockup is a graphic representation of the user interface or design of the project. It gives a visual idea of what the final demo app will look like.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 96

The "Sensors" section describes the different sensors used in the project. You will get information about the different types of sensors, their functions, properties and their implementation in the project.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Readme.md line 98

Doesn't this section describe the same as the one above?

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 130

\subsection{Creating a new user story}
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 129

\section{Adding a new feature / user story}
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 132

Imo the last sentence is unnecessary.

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 134

Maybe add a link, where you can find help about describing a user story (e. g. https://www.atlassian.com/agile/project-management/user-stories)

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 143

You don't refer to this graphic in the text.

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 143

\subsection{Adding a new feature}
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 150

I don't know, whether this really works.

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 150

\subsubsection{Creating an issue}
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 153

For example, if you want to add a new sensor to the app, you can select the issue template \textit{Feature} and fill out the template with the relevant information. This template includes sections for feature description, use case, benefits, requirements, and links/references.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 167

Same, you don't refer to this graphic

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 169

In addition to this, you should consider who should be selected as the assignee for the issue. Assigning an assignee establishes a clear responsibility. To further specify the issue and place it in the overall context of the project, you can define an \textit{Epic} and a \textit{Milestone}, if available.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 171

An Epic summarizes related features or tasks and allows for better organization and prioritization. 
A milestone helps track the progress of the project and mark important stages.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 173

In addition, you can add a predefined label to further mark the issue and make it easier to identify. This makes it easier to filter and categorize issues within the project management system.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 192

Maybe add a link to the corresponding wiki page here.

fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Commented on Requirements engineering document/re.tex line 205

The weighting of an issue is done in our regular sprint meetings, which are held every two weeks. In these meetings, we discuss together how an issue should be weighted. The weight of an issue indicates the estimated effort required to complete it within a sprint. We use a scale of 1 to 5, with a value of 1 representing the lowest effort, while a value of 5 signals the highest effort.
fgardt commented 1 year ago

In GitLab by @Merseleo on Jun 2, 2023, 17:50

Mainly typos.

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 34

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 47

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 57

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 59

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 70

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 90

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Readme.md line 96

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 130

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 129

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 143

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 150

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 153

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 169

changed this line in version 7 of the diff

fgardt commented 1 year ago

In GitLab by @mm1398 on Jun 3, 2023, 21:37

Commented on Requirements engineering document/re.tex line 171

changed this line in version 7 of the diff