Initial commit: demo-epb v1.0 — Elektrische Parkbremse Demo

Vollstaendige Demo des slohmaier Dev Process anhand einer EPB-Steuergeraet- Software. Zeigt ASPICE 4.0 / ISO 26262-konforme Entwicklung im Monorepo. Inhalte: - 5 Plaene (PID, PM-, QA-, SWE-, Test-Plan) in Word, ausgefuellt mit EPB-spezifischen Inhalten - 10 System-Anforderungen + 25 Software-Anforderungen (Doorstop-MD) - 5 System-Architektur-Elemente + 10 Software-Architektur-Elemente mit PlantUML-Diagrammen und vollstaendigem Mapping - 3 implementierte Komponenten (Apply Controller D, Actuator Driver B, Switch Debouncer QM) plus 7 Header-Stubs - 28 Unit-Tests, alle gruen, mit Coverage- und MISRA-Build-Targets - Audit-Artefakte: 1 Review-Protokoll, 1 Non-Conformity, 1 MISRA-Record - Gitea-Actions-CI-Pipeline (validate.yml) - Doorstop-Konfiguration fuer bidirektionale Traceability - Generator-Skript fuer alle 50 Reqs/Arch-Elemente aus Strukturdaten - README mit gefuehrter Tour fuer Prospects
2026-05-11 13:51:02 -07:00
commit 1855162e6d
92 changed files with 4116 additions and 0 deletions
@@ -0,0 +1,142 @@
+# demo-epb — Elektrische Parkbremse
+
+Vollstaendige Demo des [slohmaier Dev Process](https://gitea.slohmaier.com/slohmaier/dev-process) anhand einer EPB-Steuergeraet-Software. Zeigt ASPICE 4.0 / ISO 26262-konforme Entwicklung in einem Monorepo: Anforderungen, Architektur, Code, Tests, Reviews, MISRA — alles auf einen Pull-Request-Klick verifizierbar.
+
+> Diese Software ist **bewusst kein Produktivcode** — sie ist die Demonstration des Engineering-Verfahrens. Code-Umfang absichtlich klein, Prozess-Tiefe vollstaendig.
+
+## Was die Demo zeigt
+
+| Artefakt-Typ        | Anzahl | Pfad                |
+|---------------------|--------|---------------------|
+| Plaene (Word)       | 5      | `docs/*.docx`       |
+| Audit-Artefakte (Word) | 3   | `docs/reviews/`, `docs/non-conformities/`, `misra/records/` |
+| System-Anforderungen| 10     | `reqs/sys/`         |
+| Software-Anforderungen | 25  | `reqs/swe/`         |
+| System-Architektur  | 5      | `arch/sys/`         |
+| Software-Architektur| 10     | `arch/swe/`         |
+| Implementierte Komponenten | 3 (1×ASIL-D, 1×ASIL-B, 1×QM) | `src/` |
+| Stub-Komponenten    | 7      | `src/stubs/`        |
+| Unit-Tests          | 28     | `tests/unit/`       |
+| CI-Pipeline         | 1      | `.gitea/workflows/` |
+
+## Quick Start
+
+```bash
+git clone https://gitea.slohmaier.com/slohmaier/demo-epb.git
+cd demo-epb
+
+# Build + Tests
+make test
+
+# Mit Coverage (benoetigt lcov)
+make coverage
+open build/coverage-html/index.html
+
+# Statische Analyse + MISRA (benoetigt cppcheck)
+make static
+make misra
+```
+
+## Gefuehrte Tour (~30 min)
+
+### 1. Projektplanung
+Start in `docs/`:
+- **PID.docx** — Was wird gebaut und warum
+- **SWE-Plan.docx** — Wie wird gebaut: Sprache, Standards, Branching, Review-Regeln, Coverage-Ziele pro ASIL
+- **QA-Plan.docx** — Qualitaetsmassnahmen, Reviews, NC-Management
+- **PM-Plan.docx**, **Test-Plan.docx** — Arbeitspakete + Teststrategie
+
+### 2. Sicherheits-Logik (das ASIL-D Stueck)
+`reqs/sys/SYS-001.md` → `arch/swe/SWA-002.md` → `src/apply_controller.c` → `tests/unit/test_apply_controller.c`
+
+Das ist die Traceability-Kette: System-Sicherheitsziel → Software-Architektur → Code → Test.
+
+### 3. Anforderungen + Architektur (Doorstop in Markdown)
+- `reqs/sys/` und `reqs/swe/` — alle Anforderungen mit Mapping
+- `arch/sys/` und `arch/swe/` — Architektur mit Mapping per `links:` im Frontmatter
+- Eingebettete PlantUML-Diagramme rendern direkt in Gitea
+
+### 4. Code mit Mapping-Tags
+Jede `.c`-Datei traegt `@arch`, `@reqs` im Header:
+
+```c
+/**
+ * @file apply_controller.c
+ * @arch SWA-002
+ * @reqs SWE-001 SWE-002 SWE-003 SWE-004
+ *
+ * ASIL: D.
+ */
+```
+
+So ist Code -> Architektur -> Anforderung auf einen `grep` durchsuchbar.
+
+### 5. Tests mit Anforderungs-Tags
+`tests/unit/test_apply_controller.c` referenziert die Requirements per `@reqs`. CI mit Coverage-Report belegt, dass jede Anforderung getestet ist.
+
+### 6. Audit-Artefakte
+- `docs/reviews/REV-001.docx` — Review-Protokoll fuer die ASIL-D-Komponente
+- `docs/non-conformities/NC-001.docx` — Beispiel einer Non-Conformity mit Korrekturmassnahme
+- `misra/records/MISRA-REC-001.docx` — MISRA Deviation Record fuer eine bewusste Advisory-Abweichung
+
+### 7. CI-Pipeline
+`.gitea/workflows/validate.yml` — bei jedem Push laeuft:
+1. Cppcheck (Static Analysis)
+2. Cppcheck + MISRA-Addon
+3. Build + Unit Tests
+4. Coverage (gcov/lcov)
+5. Doorstop-Traceability-Check
+
+## Architektur-Ueberblick
+
+```
+                +----------------------+
+                |     EPB ECU (SA-001) |
+                |  +-----------------+ |
+                |  | Safety Mgr (D)  | |
+                |  +-----------------+ |
+                |  | Apply Ctrl (D)  | |
+                |  +-----------------+ |
+                |  | Actuator Drv (B)| |
+                |  +-----------------+ |
+                |  | Wheel Speed (B) | |
+                |  | Inclino (B)     | |
+                |  +-----------------+ |
+                |  | Switch DB (QM)  | |
+                |  | Display (QM)    | |
+                |  | Diag (QM)       | |
+                |  | Service (QM)    | |
+                |  | Logger (QM)     | |
+                |  +-----------------+ |
+                +----------------------+
+                     |        |
+              Aktor L         Aktor R
+              (SA-002)        (SA-002)
+```
+
+## Format-Strategie
+
+| Inhalt              | Format           | Begruendung                                     |
+|---------------------|-------------------|-------------------------------------------------|
+| Plaene + Audit-Doku | **Word** (.docx)  | Industriestandard fuer ISO-9001-Freigabe        |
+| Requirements + Arch | **Markdown** (Doorstop) | Lebendig, diff-bar, Traceability per Skript |
+| Code, Tests, CI     | C / YAML          | klar                                            |
+
+Beide Welten gehen ueber `tools/`-Skripte ineinander ueber: Markdown ist Source of Truth, Word wird per pandoc daraus gebaut.
+
+## Generatoren
+
+| Skript                                | Zweck                                              |
+|---------------------------------------|----------------------------------------------------|
+| `tools/generate_doorstop_items.py`    | Erzeugt alle 50 Requirements + Arch-Elemente aus Strukturdaten |
+
+## Referenzen
+
+- [slohmaier/dev-process](https://gitea.slohmaier.com/slohmaier/dev-process) — die Methodik
+- ASPICE 4.0
+- ISO 26262 (insbesondere Part 6 — Software)
+- MISRA C:2012
+
+## Lizenz
+
+MIT — siehe [LICENSE](LICENSE).