mirror of
https://github.com/fhswf/aki_prj23_transparenzregister.git
synced 2025-04-26 10:42:35 +02:00
Philipp Horstenkamp
a9304201af
* Added a first action * Repaired a typo * Repaired a typo2 * Repaired a typo2 * Added flake8 action * Repaired a typo in the flake8 action. * Added a first bandit action * Added a first batch * Added a first batch * Added a first batch * Added a first batch * Added a first batch * Added the flake8-prebuild as a need to flake8 * Added the flake8-prebuild as a need to flake8 * Added the flake8-prebuild as a need to flake8 * Added the docker socket to the volume. * Added the flake8-prebuild as a need to flake8 * Removed latest part from container. * Removed latest part from container. * Removed latest part from container. * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 * Reworked flake8 poetry * Reworked flake8 poetry * Changed to 64bit * Some edits to the runner * Added python setup * Added python -m to python docker image. * Added python -m to python docker image. * Added python -m to python docker image. * Added python -m to python docker image. * Added python -m to python docker image. * Added python -m to python docker image. * Added ra run linter * Added ra run linter * Added ra run linter * Added ra run linter * Removed redundant version * Removed redundant version * Added isort * Added isort * Added isort * Added poetry install * Added poetry install * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Uses nodejs and python image * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Added flake8 as lint. * Removed selfhosted runner * Removed self hosted runner * Removed self hosted runner * Removed self hosted runner * Added black and flake8 tests * Removed self hosted runner * Removed self hosted runner * Removed unneded actions * Added a mypy error. * Removed poetry call before boetry setup * Removed poetry call before poetry setup * Added a test to understand the poetry action better * Added a test to understand the poetry action better * Added a test to understand the poetry action better * Added a test to understand the poetry action better * Added a test to understand the poetry action better * Added a test to understand the poetry action better * Added the snook poetry builder * Reworked the repo a bit * Removed unneeded poetry installation * Added the isort action * Added isort test * Added ruff * Added full ruff configuration * Added full ruff configuration2 * Added full ruff configuration2 * Removed duplicat configurations * Removed some redundant pre-commit hooks * Removed unneeded actions. * Removed unneeded actions. * Repaired ruff * Added tests. * Removed * Removed * Removed a missing file * Removed a missing file * Removed a missing file * Removed a missing file * Removed a missing file * Added reports as artifacts * Added reports as artifacts * Added reports as artifacts * Removed the unneded poetry test * Added a license checker. * Added a license checker. * Removed some unneeded configuration. * Removed the import reformatted. * Added doc generation. * Added doc generation. * Added license summary. * Add * Add lint * Switched pip-licenses to poetry. * Switched pip-licenses to poetry. * Switched pip-licenses to poetry. * Remove some more packages. * Remove some more packages. * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added a make file * Added version codes to the main package * Changed the format of the md files * Presentation first draft * Version up and added extensions * Version up and added extensions * Version up and added extensions * Removed the venv path from docbuild * Actions version up * Actions version up * Actions version up * Actions version up * Actions version up * Actions version up * Experiements with sphinx * Experiments with sphinx * Experiments with sphinx * Experiments with sphinx * Experiments with sphinx * Experiments with sphinx * Experiments with sphinx * Experiments with sphinx * First draft of the sphinx documentation. * Added the protocol to the time series. * Added the protocol to the time series. * First draft ot a first build pipline * Added mermaid version support * Added documentations pull and branch request requirements. * Added documentations pull and branch request requirements. * Added documentations pull and branch request requirements. * Added documentations pull and branch request requirements. * Tests should now be passing * Tests should now be passing * Tests should now be passing * Tests should now be passing * Tests should now be passing * Tests should now be passing * Tests should now be passing * Tests should now be passing * Add safety * Add safety * Add safety * Added the action on pull_request_target * Added the action on pull_request_target * Added the action on pull_request_target * Added a pytest coverage report * Added a pytest coverage report * Added a pytest coverage report * Added a pytest coverage report * Added a pytest coverage report * Added a build step * Added a build step * Added a build step * Added a build step * Changed the lint action to work only on python changes. * Changed the lint action to work only on python changes. * Changed the lint action to work only on python changes. * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Added the ability to compile a html report * Coverage * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Finished test and build workflow * Repaired a bug. * Repaired a bug. * Repaired a bug. * Repaired a bug. * Repaired a bug. * Added a github branch.ref * Removed a poetry install * Docbuild now excludes templates * Added the seminarpräsentation to the documentation build * Added the seminarpräsentation to the documentation build * Added the seminarpräsentation to the documentation build * dded a few images * Changed the pre-commit image * Changed the pre-commit image * Presentation done * Never executing jupyter for sphinx * Never executing jupyter for sphinx * Never executing jupyter for sphinx * Never executing jupyter for sphinx * Never executing jupyter for sphinx
148 lines
5.3 KiB
Markdown
148 lines
5.3 KiB
Markdown
# Pflichtenheft: Kapitalgesellschaften referenzregister
|
|
|
|
Version 0.1 Erstellt am 07.04.2023
|
|
|
|
| Autoren | Matrikelnummer |
|
|
|--------------------|----------------|
|
|
| Kim Mesewinkel | 000 |
|
|
| Tristan Nolde | 000 |
|
|
| Sebastian Zelenie | 000 |
|
|
| Philip Horstenkamp | 000 |
|
|
| Sascha Zhu | 000 |
|
|
| Tim Ronneburg | 000 |
|
|
|
|
|
|
|
|
|
|
## Historie der Dokumentenversion <a name="historie"></a>
|
|
|
|
| Version | Datum | Autor | Änderungsgrund / Bemerkung |
|
|
|-----------|------------|---------------|----------------------------------------|
|
|
| 0.1 | 07.04.2023 | Tim Ronneburg | Initiales aufsetzen des Pflichtenhefts |
|
|
| 0.2 | 000 | | |
|
|
| ... | 000 | | |
|
|
| 1.0 | 000 | | |
|
|
|
|
## Inhaltsverzeichnis <a name="inhaltsverzeichnis"></a>
|
|
[Historie der Dokumentenversion](#historie)
|
|
[Inhaltsverzeichnis](#inhaltsverzeichnis)
|
|
1. [Einleitung](#einleitung)
|
|
1. [allgemeines](#allgemeines)
|
|
1. [Ziel und Zweck des Dokuments](#ziel/zweck)
|
|
1. [Ausgangssituation](#ausgangssituation)
|
|
1. [Projektbezug](#projektbezug)
|
|
1. [Abkürzungen](#abkürzungen)
|
|
1. [Schnittstellen/ Bezug zu anderen Dokumenten](#schnittstellen)
|
|
1. [Konzept und Rahmenbedingungen](#konzept_und_rahmenbedingung)
|
|
1. [Ziele des Anbieters](#ziele_anbieter)
|
|
1. [Ziele und Nutzen des Anwenders](#ziele_anwender)
|
|
1. [Benutzer / Zielgruppen](#benutzer/zielgruppen)
|
|
1. [Systemvoraussetzungen (Optional)](#systemvoraussetzungen)
|
|
1. [Ressourcen (Optional)](#ressourcen)
|
|
1. [Funktionale Anforderungen](#f_anforderung)
|
|
1. [F100](#f100)
|
|
1. [Nicht-Funktionale Anforderungen](#nf_anforderung)
|
|
1. [N100](#n100)
|
|
1. [Anforderungsverfolgung zu den Spezifikationen](#verfolgung_spezifikation)
|
|
1. [Abnahmekriterien und Vorgehen zur Ausgangsprüfung](#abnahmekriterien)
|
|
1. [Lieferumfang](#lieferumfang)
|
|
1. [Anhang / Ressourcen](#anhang/ressourcen)
|
|
|
|
|
|
## Einleitung <a name="einleitung"></a>
|
|
|
|
### Allgemeines <a name="allgemeines"></a>
|
|
|
|
### Ziel und Zweck des Dokuments <a name="ziel/zweck"></a>
|
|
|
|
### Ausgangssituation <a name="ausgangssituation"></a>
|
|
|
|
### Projektbezug <a name="projektbezug"></a>
|
|
|
|
### Abkürzungen <a name="abkürzungen"></a>
|
|
|
|
### Schnittstellen/ Bezug zu anderen Dokumenten <a name="schnittstellen"></a>
|
|
Test
|
|
|
|
## Konzept und Rahmenbedingungen <a name="konzept_und_rahmenbedingung"></a>
|
|
|
|
### Ziele des Anbieters <a name="ziele_anbieter"></a>
|
|
|
|
### Ziele und Nutzen des Anwenders <a name="ziele_anwender"></a>
|
|
|
|
### Benutzer / Zielgruppen <a name="benutzer/zielgruppen"></a>
|
|
|
|
### Systemvoraussetzungen (Optional) <a name="systemvoraussetzungen"></a>
|
|
|
|
### Ressourcen (Optional) <a name="ressourcen"></a>
|
|
|
|
|
|
|
|
## Funktionale Anforderungen <a name="f_anforderung"></a>
|
|
|
|
### **Muss Ziele**
|
|
|
|
### F100 <a name="f100"></a>
|
|
Die Software berechnet und veranschaulicht folgende Unternehmenskennzahlen:
|
|
- Umsatz
|
|
- Gewinn
|
|
- Bilanzsumme
|
|
- Eigenkapital (Eigenkapitalquote)
|
|
- Vorstand / Geschäftsführung
|
|
- Aufsichtsrat / Beirat
|
|
- Wirtschaftsprüfer
|
|
- Besitzverhältnisse
|
|
|
|
### F110 <a name="f110"></a>
|
|
Das System muss, neben den Kennzahlen von F100, die Metriken aus dem Anhang "data_and_metrics.md" je nach Datenlage für die Unternehmen berechnen und anzeigen.
|
|
|
|
### F120 <a name="f120"></a>
|
|
Die Software muss eine Suche nach Unternehmen und Personen anbieten die zu einer Detailansicht führt mit den in F100 genannten Kennzahlen.
|
|
|
|
### **Soll Ziele**
|
|
|
|
### F200 <a name="f200"></a>
|
|
Die Software veranschaulicht die Konzernstruktur (Mutterkonzern <-> Tochterfirmen). Diese sollen durch ein Netz transparent dargestellt werden.
|
|
|
|
### F210 <a name="f210"></a>
|
|
Die Software zeigt die Beziehungen von Unternehmen untereinander und mit den Wirtschaftsprüfern auf. Diese sollen durch ein Netz transparent dargestellt werden.
|
|
|
|
### F220 <a name="f220"></a>
|
|
Die Software soll bewerten ob die Berichtserstattung der letzten 7 Tage eher Positiv oder Negativ zu dem Unternehmen war. Dabei sind häufige Vorstandswechsel negativ und Zielerreichungen positiv.
|
|
|
|
## Nicht-Funktionale Anforderungen <a name="nf_anforderung"></a>
|
|
|
|
### **Muss Ziele**
|
|
|
|
### N100 <a name="n100"></a>
|
|
Das System muss die 1000 größten deutschen und europäischen Unternehmen beinhalten. Diese werden anhand der Kennzahlen
|
|
- Umsatz
|
|
-
|
|
-
|
|
bewertet und bemessen.
|
|
|
|
### **Soll Ziele**
|
|
|
|
### N200 <a name="n200"></a>
|
|
Das System ist 24/7 über das Internet für jede Person mit Internetzugang erreichbar.
|
|
|
|
### N210 <a name="n210"></a>
|
|
Das System soll eine Verfügbarkeit von 99 % erreichen, mit maximal 10 Ausfällen pro Jahr.
|
|
|
|
### **Kann Ziele**
|
|
|
|
### N300 <a name="n300"></a>
|
|
Das System kann möglichst über einen Disaster Recovery Schutz verfügen und in einem zweiten, 250 KM vom Hauptrechenzentrum entfernten Rechenzentrum die Systeme und Daten spiegeln.
|
|
|
|
### N310 <a name="n310"></a>
|
|
Das System kann möglichst skalierbar sein, sodass auch eine Nutzerzahl von 1000 Benutzern die Software nutzen können.
|
|
|
|
|
|
## Anforderungsverfolgung zu den Spezifikationen <a name="verfolgung_spezifikation"></a>
|
|
|
|
## Abnahmekriterien und Vorgehen zur Ausgangsprüfung <a name="abnahmekriterien"></a>
|
|
|
|
## Lieferumfang <a name="lieferumfang"></a>
|
|
|
|
## Anhang / Ressourcen <a name="anhang/ressourcen"></a>
|