Skip to content

docs: initial draft of requirement process - #377

Merged
hoe-jo merged 3 commits into
mainfrom
hoe_jo_initial_draft_requirement_guidance
Feb 21, 2025
Merged

hoe-jo merged 3 commits into
mainfrom
hoe_jo_initial_draft_requirement_guidance

Conversation

@hoe-jo

@hoe-jo hoe-jo commented Feb 14, 2025

Copy link
Copy Markdown
Contributor

Requirements Process description including:

  • contept
  • getting startet
  • process requirements
  • checklists
  • templates

fixed #308

Also-by: aschemmel-tech

@github-actions

Copy link
Copy Markdown
Contributor

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

@aschemmel-tech aschemmel-tech left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No OSS publishing issues found. Detailed content review pending.

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Documentation in Sphinx based on metamodel shows some issues, attribute safety/security are shown, where not needed, e.g. process requirements, having tag structure?, Attribute text for workflows and work product are not ok

Comment thread docs/process/process_areas/requirements_engineering/requirements_workflow.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_workflow.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_workflow.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_getstrt.rst Outdated
Comment thread docs/process/index.rst
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
Comment thread docs/process/process_areas/requirements_engineering/requirements_concept.rst Outdated
:status: valid
:tags: attribute, mandatory

Each requirement shall have a type of one of following options:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we have to support multi selection. E.g. A legal requirement can request a Non-Functional requirement. What shall be selected here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

In general you could select both attributes, there is no check for it that you can only name one

Requirements Process description including:
- contept
- getting startet
- process requirements
- checklists
- templates

fixed #308

Also-by: aschemmel-tech
@hoe-jo
hoe-jo force-pushed the hoe_jo_initial_draft_requirement_guidance branch from 953ea2e to 3bd31cc Compare February 21, 2025 12:46
Comment thread docs/process/process_areas/requirements_engineering/requirements_workflow.rst Outdated

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please correct the templates to the agreed form

corrected findings of 2nd review

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review findings resolved

@masc2023
masc2023 self-requested a review February 21, 2025 14:50
@hoe-jo
hoe-jo merged commit dcb33d5 into main Feb 21, 2025
@hoe-jo
hoe-jo deleted the hoe_jo_initial_draft_requirement_guidance branch February 21, 2025 14:58
@hoe-jo hoe-jo added this to the SCORE Process Audit 3 milestone Feb 27, 2025
@masc2023 masc2023 linked an issue Mar 10, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Epic: (Initial) Processes Requirements Improvement: Document requirement process

4 participants