refactor(i18n): rename docs/plaene/ -> docs/plans/
Last German folder name in demo-epb. Pairs cleanly with docs/plans-md/ (markdown source) following the project convention. All references in landing page generator, CI workflows, and cross-doc links updated.
This commit is contained in:
@@ -74,9 +74,9 @@ jobs:
|
|||||||
cp -r src/stubs "$BUNDLE/src/" 2>/dev/null || true
|
cp -r src/stubs "$BUNDLE/src/" 2>/dev/null || true
|
||||||
|
|
||||||
# All Word documents (plans, safety, manuals, audit artefacts)
|
# All Word documents (plans, safety, manuals, audit artefacts)
|
||||||
mkdir -p "$BUNDLE/docs/plaene" "$BUNDLE/docs/safety" "$BUNDLE/docs/manuals" \
|
mkdir -p "$BUNDLE/docs/plans" "$BUNDLE/docs/safety" "$BUNDLE/docs/manuals" \
|
||||||
"$BUNDLE/docs/reviews" "$BUNDLE/docs/non-conformities" "$BUNDLE/misra/records"
|
"$BUNDLE/docs/reviews" "$BUNDLE/docs/non-conformities" "$BUNDLE/misra/records"
|
||||||
cp -r docs/plaene/* "$BUNDLE/docs/plaene/" 2>/dev/null || true
|
cp -r docs/plans/* "$BUNDLE/docs/plans/" 2>/dev/null || true
|
||||||
cp -r docs/safety/* "$BUNDLE/docs/safety/" 2>/dev/null || true
|
cp -r docs/safety/* "$BUNDLE/docs/safety/" 2>/dev/null || true
|
||||||
cp -r docs/manuals/* "$BUNDLE/docs/manuals/" 2>/dev/null || true
|
cp -r docs/manuals/* "$BUNDLE/docs/manuals/" 2>/dev/null || true
|
||||||
cp -r docs/reviews/* "$BUNDLE/docs/reviews/" 2>/dev/null || true
|
cp -r docs/reviews/* "$BUNDLE/docs/reviews/" 2>/dev/null || true
|
||||||
@@ -119,7 +119,7 @@ jobs:
|
|||||||
- \`reports/test-report.html\` — Test summary with requirement mapping
|
- \`reports/test-report.html\` — Test summary with requirement mapping
|
||||||
|
|
||||||
**Documents (Word, curated):**
|
**Documents (Word, curated):**
|
||||||
- \`docs/plaene/\` — PID, PM-/QA-/SWE-/Test-Plan
|
- \`docs/plans/\` — PID, PM-/QA-/SWE-/Test-Plan
|
||||||
- \`docs/safety/\` — HARA, Safety Case, FMEDA, MISRA-Compliance, Verification-Report, Tool-Qualification
|
- \`docs/safety/\` — HARA, Safety Case, FMEDA, MISRA-Compliance, Verification-Report, Tool-Qualification
|
||||||
- \`docs/manuals/\` — User-Manual + Service-Manual
|
- \`docs/manuals/\` — User-Manual + Service-Manual
|
||||||
- \`docs/reviews/\` — Review-Protokoll(e)
|
- \`docs/reviews/\` — Review-Protokoll(e)
|
||||||
|
|||||||
@@ -164,7 +164,7 @@ jobs:
|
|||||||
fi
|
fi
|
||||||
mkdir -p "$DEPLOY"/{docs,coverage,traceability,diagrams,api-doc,reports/cppcheck,src,misra/records}
|
mkdir -p "$DEPLOY"/{docs,coverage,traceability,diagrams,api-doc,reports/cppcheck,src,misra/records}
|
||||||
cp build/index.html "$DEPLOY/index.html"
|
cp build/index.html "$DEPLOY/index.html"
|
||||||
cp -r docs/plaene docs/safety docs/manuals docs/reviews docs/non-conformities "$DEPLOY/docs/"
|
cp -r docs/plans docs/safety docs/manuals docs/reviews docs/non-conformities "$DEPLOY/docs/"
|
||||||
cp -r build/coverage-html/. "$DEPLOY/coverage/" 2>/dev/null || true
|
cp -r build/coverage-html/. "$DEPLOY/coverage/" 2>/dev/null || true
|
||||||
cp -r docs/traceability/. "$DEPLOY/traceability/"
|
cp -r docs/traceability/. "$DEPLOY/traceability/"
|
||||||
cp -r docs/diagrams/. "$DEPLOY/diagrams/"
|
cp -r docs/diagrams/. "$DEPLOY/diagrams/"
|
||||||
|
|||||||
@@ -63,7 +63,7 @@ python3 tools/render_plantuml.py
|
|||||||
## Guided tour (~30 min)
|
## Guided tour (~30 min)
|
||||||
|
|
||||||
### 1. Project planning (Word)
|
### 1. Project planning (Word)
|
||||||
`docs/plaene/`:
|
`docs/plans/`:
|
||||||
- **Project-Manual.docx** — Navigation guide, reading order, roles
|
- **Project-Manual.docx** — Navigation guide, reading order, roles
|
||||||
- **PID.docx** — What is built and why
|
- **PID.docx** — What is built and why
|
||||||
- **SWE-Plan.docx** — Language, standards, branching, reviews, coverage targets
|
- **SWE-Plan.docx** — Language, standards, branching, reviews, coverage targets
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ The following artefacts are under configuration control:
|
|||||||
| Requirements | `reqs/{sys,swe}/*.md` | Git + Doorstop item hash |
|
| Requirements | `reqs/{sys,swe}/*.md` | Git + Doorstop item hash |
|
||||||
| Architecture | `arch/{sys,swe}/*.md` | Git + Doorstop item hash |
|
| Architecture | `arch/{sys,swe}/*.md` | Git + Doorstop item hash |
|
||||||
| Safety Goals | `safety/sg/*.md` | Git |
|
| Safety Goals | `safety/sg/*.md` | Git |
|
||||||
| Plans (Word) | `docs/plaene/*.docx` | Git + document version block |
|
| Plans (Word) | `docs/plans/*.docx` | Git + document version block |
|
||||||
| Safety docs (Word) | `docs/safety/*.docx` | Git |
|
| Safety docs (Word) | `docs/safety/*.docx` | Git |
|
||||||
| Manuals (Word) | `docs/manuals/*.docx` | Git |
|
| Manuals (Word) | `docs/manuals/*.docx` | Git |
|
||||||
| Reviews + NCs | `docs/reviews/`, `docs/non-conformities/` | Git |
|
| Reviews + NCs | `docs/reviews/`, `docs/non-conformities/` | Git |
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ This Project Manual is the entry point to the demo-epb project. It answers:
|
|||||||
|
|
||||||
A complete demo of the **slohmaier Dev Process** using an EPB ECU software. The goal is **not** the productive software, but evidence of ASPICE 4.0 / ISO 26262-compliant development.
|
A complete demo of the **slohmaier Dev Process** using an EPB ECU software. The goal is **not** the productive software, but evidence of ASPICE 4.0 / ISO 26262-compliant development.
|
||||||
|
|
||||||
Detail: `docs/plaene/PID.docx`.
|
Detail: `docs/plans/PID.docx`.
|
||||||
|
|
||||||
## 3. Reading order for new project members
|
## 3. Reading order for new project members
|
||||||
|
|
||||||
@@ -52,7 +52,7 @@ Detail: `docs/plaene/PID.docx`.
|
|||||||
|
|
||||||
```
|
```
|
||||||
demo-epb/
|
demo-epb/
|
||||||
├── docs/plaene/ ← PID, PM Plan, QA Plan, SWE Plan, Test Plan, CM Plan, RM Plan
|
├── docs/plans/ ← PID, PM Plan, QA Plan, SWE Plan, Test Plan, CM Plan, RM Plan
|
||||||
├── docs/safety/ ← HARA, Safety Case, FMEDA, MISRA Compliance, Verification Report, Tool Qualification
|
├── docs/safety/ ← HARA, Safety Case, FMEDA, MISRA Compliance, Verification Report, Tool Qualification
|
||||||
├── docs/manuals/ ← User Manual, Service Manual
|
├── docs/manuals/ ← User Manual, Service Manual
|
||||||
├── docs/reviews/ ← Review minutes
|
├── docs/reviews/ ← Review minutes
|
||||||
|
|||||||
@@ -125,7 +125,7 @@ def main() -> int:
|
|||||||
n_stubs = sum(1 for f in (REPO / "src" / "stubs").glob("*.h"))
|
n_stubs = sum(1 for f in (REPO / "src" / "stubs").glob("*.h"))
|
||||||
|
|
||||||
# Word docs
|
# Word docs
|
||||||
plans = collect_docs("docs/plaene")
|
plans = collect_docs("docs/plans")
|
||||||
safety = collect_docs("docs/safety")
|
safety = collect_docs("docs/safety")
|
||||||
manuals = collect_docs("docs/manuals")
|
manuals = collect_docs("docs/manuals")
|
||||||
reviews = collect_docs("docs/reviews")
|
reviews = collect_docs("docs/reviews")
|
||||||
|
|||||||
Reference in New Issue
Block a user