slohmaier/dev-process
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(i18n): dev-process repo in English

Browse Source 
- README.md: full English rewrite
- All 13 vorlagen MD templates hand-translated:
  PID, PM-Plan, QA-Plan, SWE-Plan, Test-Plan,
  SA, SWA, Review-Protokoll, Non-Conformity,
  MISRA-Deviation-Permit, MISRA-Deviation-Record,
  Traceability-Matrix, angebot (quotation)
- Master Word template (slohmaier-doc-template.docx) regenerated
  in English: cover page, document control, TOC headers,
  classification banner all English
- All derived Word vorlagen regenerated from English MD sources

Still to translate: toolstack.md, gitea-aspice-setup.md
This commit is contained in:
Stefan Lohmaier
2026-05-12 03:42:35 -07:00
parent 6e458ae76f
commit d5cfec9e42
25 changed files with 774 additions and 875 deletions
Download Patch File Download Diff File Expand all files Collapse all files
vorlagen/MISRA-Deviation-Permit-vorlage.md
+42 -42
View File
@@ -1,76 +1,76 @@
# MISRA Deviation Permit
| Feld | Wert |
|-----------------|-------------------------------|
| Permit-ID | PER-[XXX] |
| Datum | [YYYY-MM-DD] |
| Erstellt von | [Name] |
| Field | Value |
|------------------|--------------------------------|
| Permit ID | PER-[XXX] |
| Date | [YYYY-MM-DD] |
| Author | [Name] |
---
## 1. Regelbereich
## 1. Rule
| Feld | Wert |
| Field | Value |
|-------------------|----------------------------------------------------|
| Regel-Nummer | [z.B. Rule 11.3] |
| Kategorie | [Required / Advisory] |
| Regeltext | [Exakter Text der MISRA-Regel] |
| Rule number | [e.g. Rule 11.3] |
| Category | [Required / Advisory] |
| Rule text | [Exact text of the MISRA rule] |
| Standard | [MISRA C:2012 / MISRA C:2023] |
## 2. Scope
Dieses Permit gilt fuer:
This permit applies to:
| Aspekt | Geltungsbereich |
| Aspect | Scope |
|-------------------|----------------------------------------------------|
| Code-Bereich | [z.B. src/hal/*.c — alle Hardware-Abstraction-Layer Dateien] |
| Modul / Komponente| [z.B. HAL, CAN-Treiber] |
| Kontext | [z.B. Register-Zugriffe auf Memory-Mapped I/O] |
| Code area | [e.g. src/hal/*.c — all hardware-abstraction-layer files] |
| Module / component| [e.g. HAL, CAN driver] |
| Context | [e.g. register access to memory-mapped I/O] |
**Einschraenkung:** Dieses Permit gilt ausschliesslich fuer den oben definierten Scope. Abweichungen ausserhalb dieses Bereichs erfordern einen eigenen Deviation Record oder ein separates Permit.
**Limitation:** This permit applies exclusively to the scope defined above. Deviations outside this scope require a separate deviation record or a separate permit.
## 3. Begruendung
## 3. Rationale
[Warum ist die Abweichung von dieser Regel im definierten Kontext vertretbar?]
[Why is deviation from this rule acceptable in the defined context?]
Beispiel: "Rule 11.3 verbietet Casts zwischen Pointer-Typen. Im HAL sind Casts von `uint32_t*` auf Register-Structs notwendig, da die Hardware ueber Memory-Mapped I/O angesprochen wird. Die Register-Adressen und Layouts sind durch das Datenblatt definiert und statisch. Eine regelkonforme Alternative existiert nicht."
Example: "Rule 11.3 forbids casts between pointer types. In the HAL, casts from `uint32_t*` to register structs are necessary because the hardware is accessed via memory-mapped I/O. The register addresses and layouts are defined in the datasheet and are static. A rule-compliant alternative does not exist."
**Begruendung:** [Hier ausfuellen]
**Rationale:** [Fill in here]
## 4. Risikobewertung und Alternativen
## 4. Risk assessment and alternatives
### Risikobewertung
### Risk assessment
| Aspekt | Bewertung |
| Aspect | Assessment |
|---------------------------|-----------------------------------------------|
| Sicherheitsrelevanz | [Keine / Gering / Mittel / Hoch] |
| Fehlerpotenzial | [Beschreibung] |
| Absicherung | [z.B. Unit Tests pruefen korrekte Register-Zugriffe, Code Review Pflicht fuer HAL-Code] |
| Restrisiko | [Bewertung] |
| Safety relevance | [None / Low / Medium / High] |
| Fault potential | [Description] |
| Mitigation | [e.g. unit tests verify correct register access, code review required for HAL code] |
| Residual risk | [Assessment] |
### Geprufte Alternativen
### Alternatives considered
| Alternative | Bewertung |
| Alternative | Assessment |
|--------------------------|------------------------------------------------|
| [z.B. Generische Zugriffsfunktionen] | [z.B. Nicht praktikabel, da hunderte Register] |
| [z.B. Compiler-Erweiterung] | [z.B. Nicht portabel] |
| [e.g. generic accessor functions] | [e.g. not practical due to hundreds of registers] |
| [e.g. compiler extension] | [e.g. not portable] |
## 5. Freigabe
## 5. Approval
| Feld | Wert |
| Field | Value |
|-----------------------|-----------------------------------------------|
| Freigegeben von | [Name, Rolle] |
| Datum | [YYYY-MM-DD] |
| Nachweis | [GitLab-Issue / Wiki-Verweis / Unterschrift] |
| Approved by | [Name, role] |
| Date | [YYYY-MM-DD] |
| Evidence | [Gitea issue / wiki link / signature] |
## 6. Gueltigkeit
## 6. Validity
| Feld | Wert |
| Field | Value |
|-------------------|----------------------------------------------------|
| Gueltig ab | [YYYY-MM-DD] |
| Gueltig bis | [YYYY-MM-DD oder "bis auf Widerruf"] |
| Widerrufsbedingung | [z.B. Bei Aenderung der Zielplattform neu bewerten] |
| Valid from | [YYYY-MM-DD] |
| Valid until | [YYYY-MM-DD or "until revoked"] |
| Revocation trigger | [e.g. re-evaluate if the target platform changes] |
---
*Dieses Permit wird im GitLab-Wiki unter MISRA-Deviation-Permits abgelegt und aus Deviation Records referenziert.*
*This permit is stored in the Gitea wiki under MISRA-Deviation-Permits and referenced from deviation records.*