= image:logo.png[Logo Conserve & Cook]
:revnumber: 0.1 DE
:revdate: April 2025
:revremark: (basiert auf AsciiDoc Version)
:imagesdir: ./images

== Produktdokumentation

In diesem Repository ist die Dokumentation des Produktes abgelegt.
Dazu gehört die Dokumentation von:

- Anleitungen
- Softwaredokumentation (SAD)
- Hardware-Dokumentation
- Testdokumentation
- Programmierkonventionen

=== Anleitungen
Für diverse Szenarien wurden Anleitungen verfasst.
Als erste Anlaufstelle bei Fehler gibt es die link:anleitungen/fehlerbehebung.adoc[Anleitung Fehlerbehebung].

=== Softwaredokumentation
Die link:software(sad)/software-architecture-document.adoc[Softwaredokumentation] ist nach den Vorgaben von arc42 erstellt worden (https://arc42.org/).

Die link:software(sad)/system-idee.adoc[System-Idee] enthält das grundlegende Konzept des Projekts.
Es dient als ein Einstieg in die Soft- und Hardware-Dokumentationen.

=== Hardwaredokumentation
In der link:hardware/Hardware.adoc[Hardwaredokumentation] ist alles erfasst, was zum Bauen des Produkts nötig ist.
Dazu gehören:

- *Teileliste*: In der Teileliste werden alle Teile aufgeführt, welche verbaut wurden.
- *Files*: Alle Dateien, welche für die Erstellung der physischen Bauteile gebraucht wurden.

=== Testdokumentation
Die Testdokumentation zeigt auf, wie geprüft wurde, ob das Produkt den Vorgaben entspricht.

Im link:testing/general/Testplan.adoc[Testplan] steht, was und im welchen Umfang getestet wird.

Die Datei link:testing/general/UebersichtTestCases.adoc[Testcases Übersicht] enthält eine Zusammenfassung der durchgeführten Tests.

=== Programmierkonventionen (Coding-Conventions)
Die link:software(dev)/coding_conventions.adoc[Coding Conventions] geben vor, wie der Code geschrieben wird.