diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index 4ca6bff..ff52a7d 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -74,9 +74,9 @@ jobs: cp -r src/stubs "$BUNDLE/src/" 2>/dev/null || true # 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" - 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/manuals/* "$BUNDLE/docs/manuals/" 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 **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/manuals/\` — User-Manual + Service-Manual - \`docs/reviews/\` — Review-Protokoll(e) diff --git a/.gitea/workflows/validate.yml b/.gitea/workflows/validate.yml index ceb41c3..a3400ac 100644 --- a/.gitea/workflows/validate.yml +++ b/.gitea/workflows/validate.yml @@ -164,7 +164,7 @@ jobs: fi mkdir -p "$DEPLOY"/{docs,coverage,traceability,diagrams,api-doc,reports/cppcheck,src,misra/records} 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 docs/traceability/. "$DEPLOY/traceability/" cp -r docs/diagrams/. "$DEPLOY/diagrams/" diff --git a/README.md b/README.md index 68ee3bc..191a7e8 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ python3 tools/render_plantuml.py ## Guided tour (~30 min) ### 1. Project planning (Word) -`docs/plaene/`: +`docs/plans/`: - **Project-Manual.docx** — Navigation guide, reading order, roles - **PID.docx** — What is built and why - **SWE-Plan.docx** — Language, standards, branching, reviews, coverage targets diff --git a/docs/plans-md/CM-Plan.md b/docs/plans-md/CM-Plan.md index 6cb31f7..1e7d8a9 100644 --- a/docs/plans-md/CM-Plan.md +++ b/docs/plans-md/CM-Plan.md @@ -33,7 +33,7 @@ The following artefacts are under configuration control: | Requirements | `reqs/{sys,swe}/*.md` | Git + Doorstop item hash | | Architecture | `arch/{sys,swe}/*.md` | Git + Doorstop item hash | | 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 | | Manuals (Word) | `docs/manuals/*.docx` | Git | | Reviews + NCs | `docs/reviews/`, `docs/non-conformities/` | Git | diff --git a/docs/plans-md/Project-Manual.md b/docs/plans-md/Project-Manual.md index 04d2bc9..c6c0a49 100644 --- a/docs/plans-md/Project-Manual.md +++ b/docs/plans-md/Project-Manual.md @@ -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. -Detail: `docs/plaene/PID.docx`. +Detail: `docs/plans/PID.docx`. ## 3. Reading order for new project members @@ -52,7 +52,7 @@ Detail: `docs/plaene/PID.docx`. ``` 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/manuals/ ← User Manual, Service Manual ├── docs/reviews/ ← Review minutes diff --git a/docs/plaene/CM-Plan.docx b/docs/plans/CM-Plan.docx similarity index 100% rename from docs/plaene/CM-Plan.docx rename to docs/plans/CM-Plan.docx diff --git a/docs/plaene/PID.docx b/docs/plans/PID.docx similarity index 100% rename from docs/plaene/PID.docx rename to docs/plans/PID.docx diff --git a/docs/plaene/PM-Plan.docx b/docs/plans/PM-Plan.docx similarity index 100% rename from docs/plaene/PM-Plan.docx rename to docs/plans/PM-Plan.docx diff --git a/docs/plaene/Project-Manual.docx b/docs/plans/Project-Manual.docx similarity index 100% rename from docs/plaene/Project-Manual.docx rename to docs/plans/Project-Manual.docx diff --git a/docs/plaene/QA-Plan.docx b/docs/plans/QA-Plan.docx similarity index 100% rename from docs/plaene/QA-Plan.docx rename to docs/plans/QA-Plan.docx diff --git a/docs/plaene/RM-Plan.docx b/docs/plans/RM-Plan.docx similarity index 100% rename from docs/plaene/RM-Plan.docx rename to docs/plans/RM-Plan.docx diff --git a/docs/plaene/SWE-Plan.docx b/docs/plans/SWE-Plan.docx similarity index 100% rename from docs/plaene/SWE-Plan.docx rename to docs/plans/SWE-Plan.docx diff --git a/docs/plaene/Test-Plan.docx b/docs/plans/Test-Plan.docx similarity index 100% rename from docs/plaene/Test-Plan.docx rename to docs/plans/Test-Plan.docx diff --git a/tools/generate_landing_page.py b/tools/generate_landing_page.py index ebbf0ec..29153a4 100644 --- a/tools/generate_landing_page.py +++ b/tools/generate_landing_page.py @@ -125,7 +125,7 @@ def main() -> int: n_stubs = sum(1 for f in (REPO / "src" / "stubs").glob("*.h")) # Word docs - plans = collect_docs("docs/plaene") + plans = collect_docs("docs/plans") safety = collect_docs("docs/safety") manuals = collect_docs("docs/manuals") reviews = collect_docs("docs/reviews")