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.
This commit is contained in:
@@ -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:
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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"
|
||||
@@ -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/`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user