jambor.pro/docs-onboarding
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update: Stakeholder Requirements Prozess verbessert und Traceability angepasst.

Browse source
This commit is contained in:
Jan Jambor 2024-12-20 13:02:12 +01:00
parent a0997b5523
commit 1761b026ae
4 changed files with 108 additions and 98 deletions
Download patch file Download diff file Expand all files Collapse all files

107
requirements-engineering-process.md
View file

@ -2,15 +2,19 @@
This document provides a comprehensive overview of our requirements engineering process. It is designed to help experienced professionals understand how we collect, document, and manage requirements using Azure DevOps. By adhering to this guide, we ensure consistency, traceability, and compliance throughout our projects.
The requirements engineering proicess is tightly bound to the [traceability concept](traceability-concept.md) and the [requirements gathering interview](requirements-gathering-interview.md).
Requirements are work items in Azure DevOps and the summarizing AsciiDoc document is located within the [docs-requirements](https://dev.azure.com/ypsag/ITSandbox/_git/docs-requirements) repository.
## Overview
Our requirements engineering process is a structured approach that takes us from the initial stakeholder conversations to a finalized set of requirements. We emphasize:
- **Clarity and Testability:** Requirements should be simple statements that are testable.
- **Traceability:** Maintaining a clear line from requirements through to implementation and testing.
- **Clarity and Testability:** Requirements should be simple statements that are testable. We are writing test cases along with the stakeholder requirements.
- **Traceability:** Maintaining clear links from requirements through to implementation and testing and back.
- **Compliance:** Ensuring all regulatory requirements are identified and addressed.
- **Stakeholder Engagement:** Actively involving stakeholders throughout the process.
- **Risk Management:** Identifying and mitigating risks associated with requirements.
- **Risk Management:** Identifying and mitigating risks associated with requirements. Recording them linked to the requirements.
We use **Azure DevOps** with the **CMMI process template** to manage our Work Items, facilitating collaboration and traceability.
@ -21,8 +25,8 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
**Objective:** Establish a foundational understanding of the project and build relationships with stakeholders.
- **Activities:**
- Conduct initial meetings to understand project vision and objectives.
- Establish communication channels and protocols.
- Conduct initial meetings to understand project vision and objectives with sponsors or, if already appointed, project managers.
- Establish communication channels and protocols. E.g. use Teams channels, Slack or such for quick communication.
- Set expectations for the requirements gathering process.
### 2. Stakeholder Identification
@ -30,7 +34,7 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
**Objective:** Identify all individuals and groups who have an interest in or influence over the project.
- **Activities:**
- Create a stakeholder register.
- Create a stakeholder register. This should be part of the summarizing AsciiDoc document.
- Analyze stakeholder roles, interests, and influence.
- Prioritize stakeholders based on their impact on requirements.
@ -42,8 +46,8 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
- Conduct interviews using our [Interview Questionnaire](requirements-gathering-interview.md) (refer to the separate file).
- Hold workshops and brainstorming sessions.
- Observe existing systems and workflows.
- **Outcome:**
- Capture raw requirements and create initial Requirement Work Items in Azure DevOps.
- Demonstrate and teach how unexpierenced stakeholders can review requirements and their current state in Azure DevOps.
### 4. Requirements Documentation
@ -52,7 +56,8 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
- **Activities:**
- Use the "Requirement" Work Item in Azure DevOps to record each requirement.
- Include detailed descriptions, affected regulations, and stakeholder information.
- Ensure each requirement is a simple, testable statement.
- Ensure each requirement is a simple, testable statement. Write test cases along with the requirements.
- Add acceptance criteria.
### 5. Requirements Analysis
@ -69,7 +74,7 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
- **Activities:**
- Link Requirement Work Items to related Specifications, Design Documents, Implementation Tasks, Test Cases, and other artifacts in Azure DevOps.
- Use a Traceability Matrix to map relationships (see [Traceability Matrix](#traceability-matrix)).
- Use a Traceability Matrix to map relationships (see [traceability concept](traceability-concept.md)).
### 7. Requirements Management
@ -77,7 +82,7 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
- **Principles:**
- **Immutability of Requirements:** Once a requirement is baselined, it should not be altered. If changes are needed, deprecate the old requirement and create a new version.
- **Version Control:** Use Azure DevOps to track changes and maintain history.
- **Version Control:** Use Azure DevOps Work Items to link older versions with their successors and maintain history.
- **Activities:**
- Implement a change control process for requirements updates.
- Communicate changes to all stakeholders.
@ -87,9 +92,9 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
**Objective:** Identify and mitigate risks associated with requirements early in the project.
- **Activities:**
- Document risks in the Requirement Work Items or as separate Risk Work Items.
- Document risks as separate work item of type Risk and link it to the Requirement Work Items.
- Assess the impact and likelihood of each risk.
- Develop mitigation strategies.
- Develop mitigation strategies and documente them along with the risk.
## Azure DevOps Guidelines
@ -98,74 +103,39 @@ We use **Azure DevOps** with the **CMMI process template** to manage our Work It
When creating a Requirement Work Item in Azure DevOps, ensure the following fields are populated:
- **Title:** Clear and concise summary of the requirement.
- **Description:** Detailed explanation, including purpose and background.
- **Acceptance Criteria:** Conditions that must be met for the requirement to be considered fulfilled.
- **Affected Regulations:** List any laws, standards, or regulations impacting the requirement.
- **Stakeholders:** Names or roles of stakeholders associated with the requirement.
- **Tags:** Keywords for easy filtering and identification.
- **Description:** Detailed explanation, including purpose and background.
- **Affected Regulations:** List any laws, standards, or regulations impacting the requirement.
- **Acceptance Criteria:** Conditions that must be met for the requirement to be considered fulfilled.
- **Test Cases:** Linked test cases for validating the requirement.
- **Attachments:** Include supporting documents if necessary.
### Custom Fields and Links
To capture all necessary information:
- **Custom Fields:**
- **Stakeholders:** If not already available, add a custom field to list stakeholders.
- **Regulations:** Add a field to specify affected regulations or compliance requirements.
- **Links:**
- **Affected By:** Use to link the requirement to regulations or higher-level requirements.
- **Related Work Items:** Connect to tasks, user stories, or bugs.
- **Test Cases:** Link to associated test cases validating the requirement.
### Maintaining Traceability
Traceability is crucial for tracking requirements through all stages of development.
#### Traceability Matrix
We use a Traceability Matrix to map requirements to other project artifacts.
Traceability is crucial for tracking requirements through all stages of development. We use a Traceability Matrix to map requirements to other project artifacts. As of now the document is created manually in AsciiDoc format. We aim to automate this process in the future.
**Template:**
| Requirement ID | Requirement Description | Affected Regulations | Stakeholders | Specification ID | Design Doc ID | Implementation IDs | Test Case ID(s) | Status |
|----------------|-------------------------|----------------------|--------------|------------------|---------------|--------------------|------------------|--------|
| RQ-001 | [Description] | [Regulations] | [Names] | SP-001 | DD-001 | [IDs] | TC-001 | Open |
| Requirement ID | Requirement Title | Affected Regulations | Stakeholders | Test Case ID(s) |
|----------------|-------------------|----------------------|--------------|-----------------|
| RQ-001 | [Title] | [Regulations] | [Roles] | TC-001 |
- **Requirement ID:** Unique identifier (e.g., RQ-001).
- **Specification ID:** Reference to detailed specifications.
- **Design Doc ID:** Reference to design documents.
- **Implementation IDs:** Linked Work Items for development tasks.
- **Test Case ID(s):** Linked test cases for validation.
- **Requirement ID:** Unique identifier, we are using the Azure DevOps work item id.
- **Requirement Title:** Summary of the requirement.
- **Affected Regulations:** Relevant laws, standards, or regulations. We are using a link to the requirement work item representing the regulation in Azure DevOps.
- **Test Case ID(s):** Linked test cases for validation, we are using the Azure DevOps Test Case id.
#### Work Item Linking in Azure DevOps
- Use hierarchical links (Parent/Child) to represent decomposition.
- Use **"Related"** links for associations between Work Items.
- Enforce link policies to ensure no Work Item is closed without proper linkage.
## Best Practices
## Best Practices and additional Notes
- **Simple and Testable Statements:** Write requirements that are clear and can be verified through testing.
- **Regulatory Compliance:** When regulations affect a requirement, include specific clauses or references.
- **Versioning:** Do not alter baselined requirements. Deprecate and replace with new versions as needed.
- **Stakeholder Engagement:** Keep stakeholders involved throughout the process for validation and feedback.
- **Documentation:** Maintain thorough documentation at each step to support traceability and compliance.
- **Risk Identification:** Address risks early by documenting them alongside requirements.
- **Consistent Terminology:** Use standard terms and definitions to avoid confusion.
## Additional Notes
- **Communication:**
- Utilize Azure DevOps **Discussion** section in Work Items for conversations and decisions.
- Set up notifications for stakeholders to keep them informed of updates.
- **Training:**
- Familiarize yourself with the Azure DevOps CMMI process template and our customized fields.
- Stay updated on best practices in requirements engineering.
- **Tools and Extensions:**
- Consider using Azure DevOps extensions for enhanced reporting and traceability visualization.
- **Regulatory Awareness:**
- Stay informed about regulations relevant to our projects (e.g., GDPR, HIPAA).
- Consult with compliance officers when in doubt.
- **Communication:** Utilize Azure DevOps **Discussion** section in Work Items for conversations and decisions. Set up notifications for stakeholders to keep them informed of updates.
- **Training:** Familiarize yourself with the Azure DevOps CMMI process template and our customized fields. Stay updated on best practices in requirements engineering.
- **Regulatory Awareness:** Stay informed about regulations relevant to our projects (e.g., GDPR, HIPAA). Consult with compliance officers when in doubt.
## LLM Prompt example
@ -183,8 +153,10 @@ Key Guidelines:
3. Desired Outcomes: Use "I want..." to specify what the stakeholder expects or desires to be achieved. List actions or outcomes in a concise, actionable manner.
4. Rationale: Use "This ensures..." to explain why the requirement is important or what benefit it provides.
5. Add a list of relevant acceptance criteria
6. Add a list of test cases
Example:
Title: Document Authorship and Timestamps
When creating or modifying documents,
As IT QA CSV representative,
I want every document to:
@ -194,10 +166,13 @@ This ensures compliance with the "Attributable" principle of ALCOA+.
Acceptance criteria:
- The author's name is recorded on every document.
- Timestamps are added for document creation and all modifications.
Test cases:
- Verify author name is captured on document creation.
- Verify timestamps are added for all document modifications.
The input data is:
Requirement title: Pipeline for configuring Azure DevOps Repos with Ansible
Stakeholder: IT Cloud Stream Lead
Requirement description: Creation of git repositories should follow a review process and thus team members should never manually create repositories. They should create a branch, add the new repo to a configuration file, and submit a pull request. The pipeline should then create the repository after approval automatically.
Requirement title: >>fill in the title<<
Stakeholder: >>fill in the stakeholder role<<
Requirement description: >>fill in the requirement description in your words<<
```