From 247b8311f379d83ced18f63e604ef42d763b29f2 Mon Sep 17 00:00:00 2001 From: Stefan Lohmaier Date: Tue, 12 May 2026 12:09:06 -0700 Subject: [PATCH] refactor(i18n): rename vorlagen/ -> templates/, *-vorlage -> *-template Final German naming cleanup in dev-process: - vorlagen/ -> templates/ - vorlagen-word/ -> templates-word/ - tools/generate_word_vorlagen.sh -> tools/generate_word_templates.sh - *-vorlage.md / *-vorlage.docx -> *-template.md / *-template.docx - Review-Protokoll-vorlage.* -> Review-Minutes-template.* - angebot-vorlage.* -> quote-template.* - angebot-beispiel.html -> quote-example.html All references in README.md, toolstack/toolstack.md, build_word_template.py, and generate_word_templates.sh updated. The master Word style template (slohmaier-doc-template.docx) was already English-named. The dev-process repo is now fully English in both content and structure. --- README.md | 12 ++++---- .../MISRA-Deviation-Permit-template.docx | Bin .../MISRA-Deviation-Record-template.docx | Bin .../Non-Conformity-template.docx | Bin .../PID-template.docx | Bin .../PM-Plan-template.docx | Bin .../QA-Plan-template.docx | Bin .../Review-Minutes-template.docx | Bin .../SWE-Plan-template.docx | Bin .../Test-Plan-template.docx | Bin .../quote-template.docx | Bin .../slohmaier-doc-template.docx | Bin .../MISRA-Deviation-Permit-template.md | 0 .../MISRA-Deviation-Record-template.md | 0 .../Non-Conformity-template.md | 0 .../PID-template.md | 0 .../PM-Plan-template.md | 0 .../QA-Plan-template.md | 0 .../Review-Minutes-template.md | 0 .../SA-vorlage.md => templates/SA-template.md | 0 .../SWA-template.md | 0 .../SWE-Plan-template.md | 0 .../Test-Plan-template.md | 0 .../Traceability-Matrix-template.md | 0 .../quote-example.html | 0 .../quote-template.md | 0 tools/build_word_template.py | 4 +-- ...vorlagen.sh => generate_word_templates.sh} | 26 +++++++++--------- toolstack/toolstack.md | 8 +++--- 29 files changed, 25 insertions(+), 25 deletions(-) rename vorlagen-word/MISRA-Deviation-Permit-vorlage.docx => templates-word/MISRA-Deviation-Permit-template.docx (100%) rename vorlagen-word/MISRA-Deviation-Record-vorlage.docx => templates-word/MISRA-Deviation-Record-template.docx (100%) rename vorlagen-word/Non-Conformity-vorlage.docx => templates-word/Non-Conformity-template.docx (100%) rename vorlagen-word/PID-vorlage.docx => templates-word/PID-template.docx (100%) rename vorlagen-word/PM-Plan-vorlage.docx => templates-word/PM-Plan-template.docx (100%) rename vorlagen-word/QA-Plan-vorlage.docx => templates-word/QA-Plan-template.docx (100%) rename vorlagen-word/Review-Protokoll-vorlage.docx => templates-word/Review-Minutes-template.docx (100%) rename vorlagen-word/SWE-Plan-vorlage.docx => templates-word/SWE-Plan-template.docx (100%) rename vorlagen-word/Test-Plan-vorlage.docx => templates-word/Test-Plan-template.docx (100%) rename vorlagen-word/angebot-vorlage.docx => templates-word/quote-template.docx (100%) rename {vorlagen-word => templates-word}/slohmaier-doc-template.docx (100%) rename vorlagen/MISRA-Deviation-Permit-vorlage.md => templates/MISRA-Deviation-Permit-template.md (100%) rename vorlagen/MISRA-Deviation-Record-vorlage.md => templates/MISRA-Deviation-Record-template.md (100%) rename vorlagen/Non-Conformity-vorlage.md => templates/Non-Conformity-template.md (100%) rename vorlagen/PID-vorlage.md => templates/PID-template.md (100%) rename vorlagen/PM-Plan-vorlage.md => templates/PM-Plan-template.md (100%) rename vorlagen/QA-Plan-vorlage.md => templates/QA-Plan-template.md (100%) rename vorlagen/Review-Protokoll-vorlage.md => templates/Review-Minutes-template.md (100%) rename vorlagen/SA-vorlage.md => templates/SA-template.md (100%) rename vorlagen/SWA-vorlage.md => templates/SWA-template.md (100%) rename vorlagen/SWE-Plan-vorlage.md => templates/SWE-Plan-template.md (100%) rename vorlagen/Test-Plan-vorlage.md => templates/Test-Plan-template.md (100%) rename vorlagen/Traceability-Matrix-vorlage.md => templates/Traceability-Matrix-template.md (100%) rename vorlagen/angebot-beispiel.html => templates/quote-example.html (100%) rename vorlagen/angebot-vorlage.md => templates/quote-template.md (100%) rename tools/{generate_word_vorlagen.sh => generate_word_templates.sh} (72%) diff --git a/README.md b/README.md index bac9222..748ecda 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ The two worlds — ISO-9001 audits vs day-to-day engineering — have different | Code, tests, CI | source | obvious | | Customer-facing PDFs | **PDF via pandoc** from MD | formal handover of engineering artifacts | -**Markdown templates are the source of truth**; Word is built from them via pandoc (`tools/generate_word_vorlagen.sh`). +**Markdown templates are the source of truth**; Word is built from them via pandoc (`tools/generate_word_templates.sh`). ## Monorepo structure @@ -128,7 +128,7 @@ links: */ ``` -Templates: `vorlagen/SA-vorlage.md`, `vorlagen/SWA-vorlage.md`. +Templates: `templates/SA-template.md`, `templates/SWA-template.md`. ## Reviews @@ -177,17 +177,17 @@ Runs on every push and PR: | `toolstack/toolstack.md` | Complete tool stack | | `gitea-aspice-setup.md` | Setting up Gitea for ASPICE | | `dev-process-schaubild.html` | V-model infographic | -| `vorlagen/` | Markdown templates (source of truth) | -| `vorlagen-word/` | Generated Word templates + master template `slohmaier-doc-template.docx` | +| `templates/` | Markdown templates (source of truth) | +| `templates-word/` | Generated Word templates + master template `slohmaier-doc-template.docx` | | `tools/build_word_template.py` | Builds the neutral Word master template with styles, cover page, document control | -| `tools/generate_word_vorlagen.sh` | Builds the `.docx` versions from the `.md` templates via pandoc | +| `tools/generate_word_templates.sh` | Builds the `.docx` versions from the `.md` templates via pandoc | ## Regenerate Word templates ```bash # Rebuild master template + all derived Word templates python3 tools/build_word_template.py -bash tools/generate_word_vorlagen.sh +bash tools/generate_word_templates.sh ``` The master template is ISO-9001-compliant and includes: diff --git a/vorlagen-word/MISRA-Deviation-Permit-vorlage.docx b/templates-word/MISRA-Deviation-Permit-template.docx similarity index 100% rename from vorlagen-word/MISRA-Deviation-Permit-vorlage.docx rename to templates-word/MISRA-Deviation-Permit-template.docx diff --git a/vorlagen-word/MISRA-Deviation-Record-vorlage.docx b/templates-word/MISRA-Deviation-Record-template.docx similarity index 100% rename from vorlagen-word/MISRA-Deviation-Record-vorlage.docx rename to templates-word/MISRA-Deviation-Record-template.docx diff --git a/vorlagen-word/Non-Conformity-vorlage.docx b/templates-word/Non-Conformity-template.docx similarity index 100% rename from vorlagen-word/Non-Conformity-vorlage.docx rename to templates-word/Non-Conformity-template.docx diff --git a/vorlagen-word/PID-vorlage.docx b/templates-word/PID-template.docx similarity index 100% rename from vorlagen-word/PID-vorlage.docx rename to templates-word/PID-template.docx diff --git a/vorlagen-word/PM-Plan-vorlage.docx b/templates-word/PM-Plan-template.docx similarity index 100% rename from vorlagen-word/PM-Plan-vorlage.docx rename to templates-word/PM-Plan-template.docx diff --git a/vorlagen-word/QA-Plan-vorlage.docx b/templates-word/QA-Plan-template.docx similarity index 100% rename from vorlagen-word/QA-Plan-vorlage.docx rename to templates-word/QA-Plan-template.docx diff --git a/vorlagen-word/Review-Protokoll-vorlage.docx b/templates-word/Review-Minutes-template.docx similarity index 100% rename from vorlagen-word/Review-Protokoll-vorlage.docx rename to templates-word/Review-Minutes-template.docx diff --git a/vorlagen-word/SWE-Plan-vorlage.docx b/templates-word/SWE-Plan-template.docx similarity index 100% rename from vorlagen-word/SWE-Plan-vorlage.docx rename to templates-word/SWE-Plan-template.docx diff --git a/vorlagen-word/Test-Plan-vorlage.docx b/templates-word/Test-Plan-template.docx similarity index 100% rename from vorlagen-word/Test-Plan-vorlage.docx rename to templates-word/Test-Plan-template.docx diff --git a/vorlagen-word/angebot-vorlage.docx b/templates-word/quote-template.docx similarity index 100% rename from vorlagen-word/angebot-vorlage.docx rename to templates-word/quote-template.docx diff --git a/vorlagen-word/slohmaier-doc-template.docx b/templates-word/slohmaier-doc-template.docx similarity index 100% rename from vorlagen-word/slohmaier-doc-template.docx rename to templates-word/slohmaier-doc-template.docx diff --git a/vorlagen/MISRA-Deviation-Permit-vorlage.md b/templates/MISRA-Deviation-Permit-template.md similarity index 100% rename from vorlagen/MISRA-Deviation-Permit-vorlage.md rename to templates/MISRA-Deviation-Permit-template.md diff --git a/vorlagen/MISRA-Deviation-Record-vorlage.md b/templates/MISRA-Deviation-Record-template.md similarity index 100% rename from vorlagen/MISRA-Deviation-Record-vorlage.md rename to templates/MISRA-Deviation-Record-template.md diff --git a/vorlagen/Non-Conformity-vorlage.md b/templates/Non-Conformity-template.md similarity index 100% rename from vorlagen/Non-Conformity-vorlage.md rename to templates/Non-Conformity-template.md diff --git a/vorlagen/PID-vorlage.md b/templates/PID-template.md similarity index 100% rename from vorlagen/PID-vorlage.md rename to templates/PID-template.md diff --git a/vorlagen/PM-Plan-vorlage.md b/templates/PM-Plan-template.md similarity index 100% rename from vorlagen/PM-Plan-vorlage.md rename to templates/PM-Plan-template.md diff --git a/vorlagen/QA-Plan-vorlage.md b/templates/QA-Plan-template.md similarity index 100% rename from vorlagen/QA-Plan-vorlage.md rename to templates/QA-Plan-template.md diff --git a/vorlagen/Review-Protokoll-vorlage.md b/templates/Review-Minutes-template.md similarity index 100% rename from vorlagen/Review-Protokoll-vorlage.md rename to templates/Review-Minutes-template.md diff --git a/vorlagen/SA-vorlage.md b/templates/SA-template.md similarity index 100% rename from vorlagen/SA-vorlage.md rename to templates/SA-template.md diff --git a/vorlagen/SWA-vorlage.md b/templates/SWA-template.md similarity index 100% rename from vorlagen/SWA-vorlage.md rename to templates/SWA-template.md diff --git a/vorlagen/SWE-Plan-vorlage.md b/templates/SWE-Plan-template.md similarity index 100% rename from vorlagen/SWE-Plan-vorlage.md rename to templates/SWE-Plan-template.md diff --git a/vorlagen/Test-Plan-vorlage.md b/templates/Test-Plan-template.md similarity index 100% rename from vorlagen/Test-Plan-vorlage.md rename to templates/Test-Plan-template.md diff --git a/vorlagen/Traceability-Matrix-vorlage.md b/templates/Traceability-Matrix-template.md similarity index 100% rename from vorlagen/Traceability-Matrix-vorlage.md rename to templates/Traceability-Matrix-template.md diff --git a/vorlagen/angebot-beispiel.html b/templates/quote-example.html similarity index 100% rename from vorlagen/angebot-beispiel.html rename to templates/quote-example.html diff --git a/vorlagen/angebot-vorlage.md b/templates/quote-template.md similarity index 100% rename from vorlagen/angebot-vorlage.md rename to templates/quote-template.md diff --git a/tools/build_word_template.py b/tools/build_word_template.py index 4bf1ea0..1839adb 100644 --- a/tools/build_word_template.py +++ b/tools/build_word_template.py @@ -2,7 +2,7 @@ """ Build the neutral slohmaier Word document template. -Output: vorlagen-word/slohmaier-doc-template.docx +Output: templates-word/slohmaier-doc-template.docx The template is ISO 9001 / ASPICE-friendly: - Cover page with project, doc-ID, version, classification @@ -579,5 +579,5 @@ def build_template(out_path: Path): if __name__ == "__main__": out = Path(sys.argv[1] if len(sys.argv) > 1 else - Path(__file__).resolve().parent.parent / "vorlagen-word" / "slohmaier-doc-template.docx") + Path(__file__).resolve().parent.parent / "templates-word" / "slohmaier-doc-template.docx") build_template(out) diff --git a/tools/generate_word_vorlagen.sh b/tools/generate_word_templates.sh similarity index 72% rename from tools/generate_word_vorlagen.sh rename to tools/generate_word_templates.sh index 62edbf7..52a5807 100755 --- a/tools/generate_word_vorlagen.sh +++ b/tools/generate_word_templates.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# Convert the formal-document Markdown vorlagen to Word .docx +# Convert the formal-document Markdown templates to Word .docx # using slohmaier-doc-template.docx as style reference. # # Word is the industry standard for formal release / ISO 9001 audits. @@ -9,8 +9,8 @@ set -euo pipefail REPO_ROOT="$(cd "$(dirname "$0")/.." && pwd)" -SRC="$REPO_ROOT/vorlagen" -DST="$REPO_ROOT/vorlagen-word" +SRC="$REPO_ROOT/templates" +DST="$REPO_ROOT/templates-word" TEMPLATE="$DST/slohmaier-doc-template.docx" if [[ ! -f "$TEMPLATE" ]]; then @@ -20,16 +20,16 @@ fi # Formal documents (to Word): FORMAL_DOCS=( - PID-vorlage - PM-Plan-vorlage - QA-Plan-vorlage - SWE-Plan-vorlage - Test-Plan-vorlage - Review-Protokoll-vorlage - Non-Conformity-vorlage - MISRA-Deviation-Permit-vorlage - MISRA-Deviation-Record-vorlage - angebot-vorlage + PID-template + PM-Plan-template + QA-Plan-template + SWE-Plan-template + Test-Plan-template + Review-Minutes-template + Non-Conformity-template + MISRA-Deviation-Permit-template + MISRA-Deviation-Record-template + quote-template ) mkdir -p "$DST" diff --git a/toolstack/toolstack.md b/toolstack/toolstack.md index f867ddf..6ac81cd 100644 --- a/toolstack/toolstack.md +++ b/toolstack/toolstack.md @@ -87,9 +87,9 @@ doorstop check # bidirectional, fails on gaps doorstop publish all docs/traceability/ # generate traceability matrix ``` -Templates under `dev-process/vorlagen/`: -- `SA-vorlage.md` — System Architecture Element -- `SWA-vorlage.md` — Software Architecture Element +Templates under `dev-process/templates/`: +- `SA-template.md` — System Architecture Element +- `SWA-template.md` — Software Architecture Element SWD is only mandatory for ASIL-C/D; for QM/A/B, code + header comments are sufficient. @@ -114,7 +114,7 @@ Cppcheck with the MISRA addon checks C code for MISRA compliance. Free, runs in cppcheck --addon=misra --error-exitcode=1 src/ ``` -Deviation permits and records are kept as Markdown files in the `misra/` directory. Templates under `dev-process/vorlagen/`. +Deviation permits and records are kept as Markdown files in the `misra/` directory. Templates under `dev-process/templates/`. ---