Files
Stefan Lohmaier 8ea3f3d8f4 templates-de: German document templates, moved in from ownCloud
The 25 files under templates-de/ lived in ~/ownCloud/Persönlich/slohmaier.com/vorlagen/
with no version control. They are the German-language counterpart of the
templates renamed to English in 247b831 — this repo already describes itself as
holding the ASPICE 4.0 / ISO 26262 methodology, templates and tools, so a
second home for templates would have been a duplicate.

Structure preserved as found (business/, engineering/, projekt/, qualitaet/).
No file renamed, no template content changed.

Not moved: vorlagen/slohmaier-doc-template.docx was byte-identical (MD5
31b2d0748eadf0314babf469725ee0b1) to templates-word/slohmaier-doc-template.docx
already in this repo.

Path references fixed in templates-de/README.md, which pointed at locations
that no longer exist: the ownCloud cp examples now clone from Gitea, the
generator script name follows the vorlagen/ -> templates/ rename
(generate_word_vorlagen.sh -> generate_word_templates.sh), the edit workflow
names templates/ and templates-de/ instead of the removed ownCloud copy, and
the master template is referenced at ../templates-word/.
2026-07-31 09:55:33 +02:00

105 lines
4.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# templates-de — Deutschsprachige slohmaier Dokument-Vorlagen
Zentrale Sammlung wiederverwendbarer Dokument-Vorlagen. Sowohl Word (für formelle
Freigabe / ISO-9001-Audits / Kunden-Lieferung) als auch Markdown (für lebendige
Engineering-Artefakte mit Git-Diff und Traceability).
> **Herkunft (2026-07-31):** Dieser Ordner lag bis dahin als `vorlagen/` im
> ownCloud-Share `~/ownCloud/Persönlich/slohmaier.com/` — ohne Versionskontrolle.
> Er ist hierher gezogen, weil dieses Repo laut eigener Beschreibung bereits
> „ASPICE 4.0 / ISO 26262 Methodik, **Vorlagen**, Tools" hält; ein zweiter
> Vorlagen-Ort wäre ein Duplikat gewesen.
>
> **Verhältnis zu `templates/` und `templates-word/`:** Das sind dieselben
> Vorlagen, seit Commit `247b831` ins Englische übersetzt und umbenannt
> (`*-vorlage` → `*-template`). `templates-de/` ist der deutschsprachige
> Stand. Beide sind gültig — wähle die Sprache, in der das Dokument geliefert
> wird. Wer eine Vorlage inhaltlich ändert, muss beide Sprachstände nachziehen.
>
> `slohmaier-doc-template.docx` ist **nicht** mit umgezogen: die ownCloud-Datei
> war byte-identisch (MD5 `31b2d074…`) mit dem bereits im Repo liegenden
> `templates-word/slohmaier-doc-template.docx`.
## Struktur
```
templates-de/
├── business/ Vertrieb + Kommunikation
│ ├── angebot-vorlage.{md,docx}
│ └── angebot-beispiel.html
├── projekt/ Projektplanung (für jedes neue Projekt)
│ ├── PID-vorlage.{md,docx} Project Initiation Document
│ ├── PM-Plan-vorlage.{md,docx} Projektmanagement-Plan
│ ├── QA-Plan-vorlage.{md,docx} Qualitätssicherungs-Plan
│ ├── SWE-Plan-vorlage.{md,docx} Software Development Plan
│ └── Test-Plan-vorlage.{md,docx} Teststrategie
├── qualitaet/ QM / Audit / Compliance
│ ├── Review-Protokoll-vorlage.{md,docx}
│ ├── Non-Conformity-vorlage.{md,docx}
│ ├── MISRA-Deviation-Permit-vorlage.{md,docx}
│ └── MISRA-Deviation-Record-vorlage.{md,docx}
└── engineering/ Anforderungen + Architektur (nur Markdown)
├── SA-vorlage.md System-Architektur-Element
├── SWA-vorlage.md Software-Architektur-Element
└── Traceability-Matrix-vorlage.md
```
## Master-Word-Template
`../templates-word/slohmaier-doc-template.docx` ist die Grundlage aller
Word-Vorlagen. Enthält:
- Deckblatt (Projekt, Dokument-ID, Version, Klassifikation)
- Document Control (Freigaben, Änderungshistorie, Verteiler) — ISO-9001-konform
- Auto-Verzeichnisse (Inhalt, Abbildungen, Tabellen, Abkürzungen)
- Formatvorlagen: H1H4, Body, Code, Note, Warning, Requirement
- Header/Footer mit Projekt, Dokument-ID, Klassifikation, Seitennummer
Bei neuem formellem Dokument: **Master-Template kopieren → ausfüllen.** Oder die
fertigen `*-vorlage.docx` als Startpunkt nehmen, die schon den passenden Inhalt
strukturiert haben.
## Word vs Markdown — welches Format wann?
| Verwendung | Format |
|-------------------------------------------|-----------|
| Freigabe, Unterschrift, Audit-Lieferung | **Word** |
| Lebendige Anforderungen, Doorstop-Diff | **Markdown** |
| Architektur mit PlantUML, in Gitea geprüft| **Markdown** |
| Kunden-PDF aus Engineering-Markdown | Markdown + pandoc-Export |
## Source-of-Truth & Neugenerierung
Die Word-Vorlagen werden aus den Markdown-Vorlagen per pandoc generiert. Der
Source liegt in **diesem** Repo — seit dem Umzug gibt es keine ownCloud-Kopie
mehr, aus der man nachziehen müsste.
- **Methodik-Repo:** https://gitea.slohmaier.com/slohmaier/dev-process
- **Lokal:** `~/git/dev-process/`
- **Generieren (englischer Stand):** `python3 tools/build_word_template.py && bash tools/generate_word_templates.sh`
Wenn du die Vorlagen anpasst:
1. Markdown editieren — `templates/<datei>.md` (EN) bzw. `templates-de/<bereich>/<datei>.md` (DE)
2. Word-Versionen mit den Skripten oben neu erzeugen
3. Beide Versionen committen + pushen
> Die Generator-Skripte in `tools/` erzeugen bislang nur den englischen Stand
> nach `templates-word/`. Die `.docx` unter `templates-de/` sind der zuletzt
> von Hand erzeugte deutsche Stand und werden noch nicht automatisch gebaut.
## Einsatz im neuen Projekt
```bash
# Beispiel-Workflow
git clone https://gitea.slohmaier.com/slohmaier/dev-process.git ~/git/dev-process
mkdir mein-neues-projekt && cd mein-neues-projekt && mkdir -p docs
cp ~/git/dev-process/templates-de/projekt/PID-vorlage.docx docs/PID.docx
cp ~/git/dev-process/templates-de/projekt/SWE-Plan-vorlage.docx docs/SWE-Plan.docx
# ... ausfüllen mit Projekt-Inhalt
```
Beispiel eines vollständig angewandten Templates: https://gitea.slohmaier.com/slohmaier/demo-epb