Home - tj0vtj0v/KI-B-4-Software_Engineering GitHub Wiki
Project Wiki
Welcome to the project wiki! This serves as the central hub for all documentation related to the project. It outlines the test-driven development workflow, details the project structure, and provides guidance through each phase of the software engineering process.
Each major topic listed in the Table of Contents has its own dedicated page. The chapters below include a brief overview and a link to the corresponding detailed section.
Table of Contents
- Project Overview
- Workflow & Iterative Plan
- Requirements Engineering
- Development Environment
- Software Architecture
- Software Design
- Implementation & Iterations
- Testing & Quality Assurance
- Traceability Matrix
- References & Sources
Project Overview
This section outlines the general scope of the project, its goals, and expected deliverables.
It also describes the structure and focus of the implementation.
Read the full Project Overview
Workflow & Iterative Plan
This chapter outlines the entire development workflow, the structure of agile iterations, and the deliverables at the end of each sprint.
Requirements Engineering
This chapter describes the process of specifying and organizing the system requirements. It is divided into two main categories:
Functional Requirements define what the system should do — the specific features, interactions, and behaviors expected from the software.
Non-functional Requirements describe how the system should perform — including constraints and quality aspects.
Full Requirement Documentation
Development Environment
This chapter outlines the tools, technologies, and processes selected to enable efficient and maintainable software development. It includes the rationale behind technology choices, project management approaches, and coding guidelines such as naming conventions, branching strategies, and testing practices.
Detailed Environment Description
Software Architecture
This chapter presents the overall structural design of the software system, detailing its key architectural elements and decisions.
Overview: Provides a high-level description of the system’s architecture, outlining its main components and their relationships.
Assumptions: Lists foundational premises and constraints created to establish a complete conceptual model that guides architectural choices and system behavior.
Interfaces of Components: Describes the defined interaction points between components, external systems, and users.
Explore the Stack Architecture
Software Design
This chapter outlines the key design elements of the software, focusing on major modules, data structures, and how components interact. It establishes a conceptual foundation for implementation.
Evaluate the initial Design Choices
Implementation & Iterations
This chapter documents the structured development process and the project's iterative progress.
Procedure: Describes the standardized workflow followed in each iteration.
Iterations: Summarizes each development cycle in a separate document.
Testing & Quality Assurance
This chapter summarizes the testing strategy and quality measures. It includes the testing procedure, coverage decisions, and expected outcomes.
Traceability Matrix
This chapter defines a matrix that tracks each requirement throughout the development process, ensuring full coverage and providing traceability.
References & Sources
This chapter provides an overview of all referenced materials, utilized tools, and the role of AI assistance in the project.
Last updated: 2025-05-18