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

update: Requirements Engineering Prozess dokumentiert und Beispiel-Fragebogen angepasst.

Browse source
This commit is contained in:
Jan Jambor 2024-11-28 13:33:36 +01:00
parent 8958969e0e
commit 32a2578826
2 changed files with 277 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

168
requirements-engineering-process.md Normal file
View file

@ -0,0 +1,168 @@
# Requirements Engineering Process
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.
## 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.
- **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.
We use **Azure DevOps** with the **CMMI process template** to manage our Work Items, facilitating collaboration and traceability.
## Process Steps
### 1. Initial Engagement
**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.
- Set expectations for the requirements gathering process.
### 2. Stakeholder Identification
**Objective:** Identify all individuals and groups who have an interest in or influence over the project.
- **Activities:**
- Create a stakeholder register.
- Analyze stakeholder roles, interests, and influence.
- Prioritize stakeholders based on their impact on requirements.
### 3. Requirements Gathering
**Objective:** Collect detailed requirements from stakeholders.
- **Activities:**
- 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.
### 4. Requirements Documentation
**Objective:** Document requirements clearly and comprehensively.
- **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.
### 5. Requirements Analysis
**Objective:** Refine and validate the collected requirements.
- **Activities:**
- Analyze requirements for clarity, completeness, and feasibility.
- Identify and resolve conflicts or duplicates.
- Validate requirements with stakeholders.
### 6. Traceability
**Objective:** Maintain end-to-end traceability of requirements through the project lifecycle.
- **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)).
### 7. Requirements Management
**Objective:** Manage changes to requirements systematically.
- **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.
- **Activities:**
- Implement a change control process for requirements updates.
- Communicate changes to all stakeholders.
### 8. Risk Management
**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.
- Assess the impact and likelihood of each risk.
- Develop mitigation strategies.
## Azure DevOps Guidelines
### Requirement Work Item Structure
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.
- **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.
**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:** 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.
#### 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
- **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.

144
requirements-gathering-interview.md
View file

@ -1,63 +1,137 @@
# Requirements Gathering Interview
# Requirements Gathering Interview Template
This guide should help anyone in our team to conduct a requirements gathering interview and collect information about the needs, desires, and constraints of stakeholders.
- The goal is to collect comprehensive information about stakeholders' needs, expectations, and constraints to inform project requirements accurately. These items can be initially basic and refined over time, but they should capture all identified requirements from the interview. How to Conduct a Requirements Gathering Interview
As an outcome we want to have Requirement work items in Azure DevOps. They can rather raw and empty but should be created for each requirement we gather. They can be refined later on.
## How to Conduct a Requirement Gathering Interview?
## How to Conduct a Requirements Gathering Interview
### Preparation
- **Identify Stakeholders:** Determine who needs to be interviewed. This could include business-users, project sponsors and managers, and qa as well as csv staff.
- **Research:** Understand the background of the project and the implication and impact of the project on the stakeholders.
- **Define Objectives:** Know what you need to find out from the specific interview and stakeholder. Have clear focus and goals in mind. E.g. a business person will have different needs than a qa person.
- **Prepare Questions:** Use this list of questions as a basis, adjust it to the stakeholder’s roles and the project’s context.
- Identify Stakeholders: Determine who needs to be interviewed, such as business users, project sponsors, managers, QA personnel, and compliance staff.
- Research: Understand the project's background and its impact on stakeholders.
- Define Objectives: Clarify what information you need from each stakeholder based on their role.
- Prepare Questions: Customize the interview questions to fit the stakeholder's role and the project's context.
- Logistics: Schedule the interview and inform the stakeholder about its purpose and expected duration.
### Conducting the Interview
### During the Interview
- **Explain the Purpose:** Clearly explain why you are conducting the interview and what you hope to achieve.
- **Ask Open-Ended Questions:** Encourage detailed responses by asking questions that cannot be answered with a simple “yes” or “no”.
- **Take Notes:** Document the key points of the conversation as Requirements in Azure DevOps.
- Explain the Purpose: Start by clearly stating why you're conducting the interview and what you hope to achieve.
- Establish Rapport: Build a comfortable environment to encourage open communication.
- Ask Open-Ended Questions: Use questions that prompt detailed responses rather than simple yes/no answers.
- Active Listening: Pay attention to the stakeholder's answers and ask follow-up questions as needed.
- Document Responses: Take thorough notes or record the conversation (with permission) for accuracy.
### After the Interview
- Review Notes: Go over your notes promptly to ensure clarity and completeness.
- Create Requirement Work Items: For each requirement discussed, create a Requirement Work Item in Azure DevOps.
- Follow-Up: If necessary, reach out for clarification on any ambiguous points.
- Validation: Send a summary to the stakeholder to confirm understanding and accuracy.
## Interview Questions
### General Questions
- Can you describe your role and how it relates to this project?
- What are the main goals you want to achieve with this project?
- Who are the end-users of this product/service?
- What problems or challenges are you currently facing that this project should address?
- Role Understanding:
Can you describe your role and responsibilities within the organization?
- Project Involvement:
How does this project relate to your work or department?
- Objectives:
What are the main goals you want to achieve with this project?
- End-Users:
Who will be the primary users of this system or service?
- Current Challenges:
What problems or challenges are you currently facing that this project should address?
### Functional Requirements
- What specific features or functions do you need the system to have?
- Can you walk me through a typical use case or workflow?
- Are there any specific tasks that the system must perform?
- Features and Functions:
What specific features or functionalities do you need the system to have?
- Processes:
Can you walk me through a typical workflow or use case?
- Tasks:
What tasks must the system enable users to perform?
- Automation:
Are there manual processes that could be automated through this system?
### Non-Functional Requirements
- What performance criteria should the system meet (e.g. speed, reliability)?
- Are there any security requirements or concerns we should be aware of?
- What are the scalability requirements for the system?
- Performance:
What performance criteria should the system meet (e.g., speed, responsiveness)?
- Security:
Are there any security requirements or concerns we should be aware of?
- Scalability:
How should the system handle growth in users or data volume?
- Reliability:
What uptime or availability is expected for the system?
- Compliance:
Are there industry standards or regulations we need to comply with?
### User Interface and Experience
- Do you have any preferences or standards for the user interface design?
- Are there any accessibility requirements we need to consider?
- What kind of user training or support will be necessary?
- Design Preferences:
Do you have any preferences or standards for the user interface design?
- Accessibility:
Are there any accessibility requirements we need to consider?
- User Training:
What kind of training or support will users need?
- Localization:
Will the system need to support multiple languages or regions?
### Data and Integration
- What data needs to be captured, stored, and processed by the system?
- Are there existing systems or databases that this project needs to integrate with?
- What data privacy and compliance requirements must be followed?
- Data Requirements:
What data needs to be captured, stored, and processed by the system?
- Existing Systems:
Are there current systems or databases that need to integrate with this project?
- Data Migration:
Is there existing data that needs to be migrated to the new system?
- Data Privacy:
What data privacy and protection requirements must be followed?
### Constraints and Assumptions
- Are there any budget or time constraints we need to consider?
- What assumptions are we making about this project that need to be validated?
- Are there any risks or potential obstacles you foresee?
- Budget and Timeline:
Are there any budget or time constraints we need to consider?
- Technological Constraints:
Are there specific technologies or platforms we must use or avoid?
- Assumptions:
What assumptions are we making that need to be validated?
- Resource Availability:
What resources (personnel, equipment) are available or limited?
### Success Criteria
- How will you measure the success of this project?
- What outcomes are most important to you?
- Are there any key performance indicators (KPIs) that we should track?
- Measuring Success:
How will you measure the success of this project?
- Key Outcomes:
What outcomes are most important to you?
- KPIs:
Are there specific Key Performance Indicators we should track?
### Risks and Challenges
- Potential Obstacles:
What risks or potential challenges do you foresee?
- Risk Mitigation:
Do you have suggestions for mitigating these risks?
- Dependencies:
Are there dependencies on other projects or initiatives?
## Tips for Effective Interviews
- Be Prepared:
Familiarize yourself with the stakeholder's background and the project's context.
- Build Trust:
Be respectful and professional to encourage honest and open dialogue.
- Clarify and Summarize:
Restate key points to confirm understanding.
- Stay Flexible:
Be prepared to explore new topics that arise during the conversation.
- Avoid Jargon:
Use clear language and explain any necessary technical terms.
- Manage Time:
Keep track of time to cover all essential questions without rushing.
- Seek Permission:
Always ask before recording the interview or sharing sensitive information.
- Follow Ethical Guidelines:
Respect confidentiality and handle all information appropriately.