Skip to content

Conversation

@aschemmel-tech
Copy link
Contributor

Resolves: #106

@github-actions
Copy link

The created documentation from the pull request is available at: docu-html

@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-req-inspect-template branch from 31abcba to 120e8e5 Compare October 27, 2025 14:36
@aschemmel-tech aschemmel-tech changed the title Create Req Inspection Template Create Req Inspection Template in Folders Oct 27, 2025
@aschemmel-tech aschemmel-tech marked this pull request as ready for review October 27, 2025 14:41
Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we not remove the checklist now from the requirements engineering process, guidance an link here to the templates?

Copy link
Contributor

@PandaeDo PandaeDo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same findings in both inspection lists. Only remarked one.

-
-
* - REQ_02_02
- Is the requirement description *unambiguous* ?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be already covered as part of comprehensible or do we want to keep it explicitly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep, as the guidance hints in another direction including tool support. We could drop if fully automated.

-
-
* - REQ_03_01
- For stakeholder requirements: Is the *rationale* correct?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we keep it here as this is for feature requirements? I assume argument is to have one checklist for all level, IIRC.

Copy link
Contributor Author

@aschemmel-tech aschemmel-tech Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed in process community - decided to stay with one template.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fine with me.

-
* - REQ_05_01
- Do the software requirements consider *timing constraints of the parent requirement*?
- This bullet point encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the implementation will be time consuming, one should think of the expectation of a "user".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- This bullet point encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the implementation will be time consuming, one should think of the expectation of a "user".
- This bullet point encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the code execution will be time consuming, one should think of the expectation of a "user".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically every code takes time to execute. Maybe we can consider some rewording.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, I will try to reformulate.

-
-
* - REQ_05_01
- Do the software requirements consider *timing constraints of the parent requirement*?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why parent requirements. Also would it be are timing constraints considered properly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this comes from the idea that safety timing constraints usually come from some FTTI set on system level.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed as covered in the "Guidance"

- Issue link
* - REQ_01_01
- Is the requirement sentence template used?
- see :need:`gd_temp__req_formulation`, this includes the use of "shall".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could consider to refer to RFC2119

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have said reference to S-CORE formulation template is enough. Why pulling in another standard? I am not in favour of also allowing "must", "should", "may".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fine with me.

-
* - REQ_03_01
- For stakeholder requirements: Is the *rationale* correct?
- Rationales explain why the top level requirements were invented. Do those cover the requirement?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Rationales explain why the top level requirements were invented. Do those cover the requirement?
- Rationales explain why the top level requirements were created. Do those cover the requirement?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@aschemmel-tech
Copy link
Contributor Author

aschemmel-tech commented Nov 6, 2025

Currently in progress the piloting in the "baselibs" team: eclipse-score/score#1947 - incorporate feedback here or in separate PR? Discussed in process community - decided to incorporate fixes from piloting here. Set to "draft" until piloting done.

@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-req-inspect-template branch from 3039e08 to 0b3df5c Compare November 18, 2025 15:06
@aschemmel-tech aschemmel-tech marked this pull request as ready for review November 19, 2025 15:42
@aschemmel-tech aschemmel-tech merged commit adc95be into main Nov 20, 2025
5 checks passed
@aschemmel-tech aschemmel-tech deleted the aschemmel-tech-req-inspect-template branch November 20, 2025 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Pilot the Inspection Process

5 participants