fb2c083551
Validate / build-test (macos-latest) (push) Failing after 3s
Validate / build-test (windows-latest) (push) Failing after 15s
Validate / build-test (ubuntu-latest) (push) Successful in 17s
Validate / reports (push) Successful in 50s
Release / release (push) Successful in 50s
Phase 2 of the English translation: Word documents (filled, EPB-specific): - 8 plans (PID, PM, QA, SWE, Test, Project Manual, CM, RM) - 6 safety docs (HARA, Safety Case, FMEDA, MISRA Compliance, Verification Report, Tool Qualification Cppcheck) - 2 manuals (User, Service) - 3 audit artefacts (Review minutes, NC-001, MISRA-REC-001) - All regenerated via pandoc from English markdown sources Code, tests, headers: - All file headers, struct comments, function docstrings in English - All test names (TEST_BEGIN strings) translated - Inline comments translated - 46 tests still green after translation CI workflows: - All step names in English - Step descriptions, comments, release notes template in English README.md fully rewritten in English with proper guided tour. Phase 3 (still pending): dev-process repo templates + toolstack/setup docs.
108 lines
5.0 KiB
Markdown
108 lines
5.0 KiB
Markdown
# Project Initiation Document (PID)
|
|
|
|
| Field | Value |
|
|
|-----------------|--------------------------------------|
|
|
| Project | demo-epb (Electric Parking Brake) |
|
|
| Project ID | SLM-EPB-001 |
|
|
| Client | slohmaier.com (in-house demo) |
|
|
| Contractor | Stefan Lohmaier |
|
|
| Date | 2026-05-11 |
|
|
| Version | 1.0 |
|
|
| Status | Released |
|
|
| Classification | Public |
|
|
|
|
---
|
|
|
|
## 1. Project purpose
|
|
|
|
Demonstration of the slohmaier Dev Process using an EPB ECU software. The goal is not the productive software but a complete demonstration of:
|
|
|
|
- ASPICE 4.0-compliant development flow
|
|
- ISO 26262-compliant handling of safety requirements (ASIL-D / ASIL-B / QM)
|
|
- MISRA C compliance
|
|
- Toolchain: Gitea + Doorstop + Cppcheck + gcov + CppUTest + pandoc
|
|
|
|
The target audience is potential customers who want to see what a real audit-ready engineering snapshot looks like.
|
|
|
|
## 2. Product description
|
|
|
|
An Electric Parking Brake (EPB) clamps two rear callipers via small electric motors at standstill and releases them on drive-away. Functional scope:
|
|
|
|
- Apply / Release on driver request
|
|
- Hold function with auto-apply on engine-off
|
|
- Drive-Away-Assist (auto-release on drive-away)
|
|
- Hill-Hold on inclines
|
|
- Actuator current monitoring
|
|
- Service mode for the workshop
|
|
- UDS diagnostics via CAN
|
|
|
|
## 3. Safety goals
|
|
|
|
| ID | Safety goal | ASIL |
|
|
|-------|---------------------------------------------------------------|------|
|
|
| SG-01 | Prevent unintended vehicle roll-away | D |
|
|
| SG-02 | Prevent unintended release of the parking brake | D |
|
|
| SG-03 | Prevent motor damage from overload | B |
|
|
|
|
Safety goals are detailed further in the system requirements (`reqs/sys/`).
|
|
|
|
## 4. Stakeholders
|
|
|
|
| Role | Person / Function |
|
|
|--------------------|--------------------------------|
|
|
| Project Owner | Stefan Lohmaier |
|
|
| Technical Lead | Stefan Lohmaier |
|
|
| Quality Assurance | Stefan Lohmaier |
|
|
| Reviewer | External reviewer (TBD) |
|
|
| Customer (demo) | Prospects / interested parties |
|
|
|
|
In a real project QA and TL would be separate persons; in this demo the role separation is kept on paper.
|
|
|
|
## 5. Deliverables
|
|
|
|
| Artefact | Format | Status |
|
|
|-------------------------------------------|---------------|-------------|
|
|
| PID, PM Plan, QA Plan, SWE Plan, Test Plan | Word | Available |
|
|
| System Requirements (SYS-001..010) | Doorstop MD | Available |
|
|
| Software Requirements (SWE-001..025) | Doorstop MD | Available |
|
|
| System Architecture (SA-001..005) | Doorstop MD | Available |
|
|
| Software Architecture (SWA-001..010) | Doorstop MD | Available |
|
|
| Source code (3 demo components) | C99 | Available |
|
|
| Unit tests + coverage report | CppUTest, lcov | Available |
|
|
| MISRA report | Cppcheck XML | Available |
|
|
| Traceability matrix | Doorstop HTML | Generated in CI |
|
|
| Review minutes (example) | Word | Available |
|
|
| MISRA Deviation Record (example) | Word | Available |
|
|
|
|
## 6. Schedule
|
|
|
|
Demo project, single-sprint creation. One-day initial creation, maintenance thereafter.
|
|
|
|
| Phase | Start | End |
|
|
|-------------------------------|-------------|-------------|
|
|
| Concept + setup | 2026-05-11 | 2026-05-11 |
|
|
| Requirements + architecture | 2026-05-11 | 2026-05-11 |
|
|
| Implementation of demo components | 2026-05-11 | 2026-05-11 |
|
|
| Tests + CI | 2026-05-11 | 2026-05-11 |
|
|
| Release v1.0 | 2026-05-11 | 2026-05-11 |
|
|
|
|
## 7. Budget
|
|
|
|
Demo project, no external budget. Internal effort.
|
|
|
|
## 8. Risks
|
|
|
|
| Risk | Likelihood | Impact | Mitigation |
|
|
|-----------------------------------------------|------------|--------|----------------------------------------------|
|
|
| Demo is mistaken for production-ready code | M | M | Disclaimer in README + plain labelling |
|
|
| MISRA tooling update breaks CI | L | M | Pin tool versions in CI |
|
|
| Reviewer availability | M | L | Self-review documented (demo only) |
|
|
|
|
## 9. Success criteria
|
|
|
|
- All 35 requirements are linked and covered by architecture
|
|
- `doorstop check` is green
|
|
- MISRA check in CI is green (with documented deviations)
|
|
- Demo-component coverage meets target (see SWE Plan)
|
|
- The guided tour in the README is navigable by a prospect in < 30 min
|