From f92acf0b0efa7b656b96310743ec1c067fd39f03 Mon Sep 17 00:00:00 2001 From: Benjamin Wolf Date: Thu, 5 Sep 2024 16:19:46 +0200 Subject: [PATCH] Remove REMARKS stuff --- ...to-expect-of-an-advanced-level-module.adoc | 2 -- .../02-advanced-level-knowledge.adoc | 2 -- docs/00a-preamble/03-prerequisites.adoc | 2 -- docs/00a-preamble/preface-ireb.adoc | 2 -- .../01-what-to-expect-of-this-module.adoc | 2 -- ...structure-and-chronological-breakdown.adoc | 11 --------- .../03-timing-didactics-and-more.adoc | 4 ---- .../04-prerequisites-for-this-training.adoc | 3 --- docs/00b-basics/05-curriculum-outline.adoc | 2 -- .../06-complementary-information.adoc | 2 -- .../01-duration-terms.adoc | 2 -- .../02-learning-goals.adoc | 7 +----- docs/02-Clean-Start/01-duration-terms.adoc | 2 -- docs/02-Clean-Start/02-learning-goals.adoc | 7 +----- .../01-duration-terms.adoc | 2 -- .../02-learning-goals.adoc | 7 +----- .../01-duration-terms.adoc | 2 -- .../01-duration-terms.adoc | 2 -- docs/06-Prioritization/01-duration-terms.adoc | 2 -- .../01-duration-terms.adoc | 2 -- docs/08-Tools/00-structure.adoc | 2 -- docs/08-Tools/01-duration-terms.adoc | 2 -- docs/42-glossary/00-glossary.adoc | 20 +--------------- docs/99-references/00-references.adoc | 2 -- docs/config/setup.adoc | 24 +------------------ scripts/includeLearningObjectives.gradle | 3 --- 26 files changed, 5 insertions(+), 115 deletions(-) diff --git a/docs/00a-preamble/01-what-to-expect-of-an-advanced-level-module.adoc b/docs/00a-preamble/01-what-to-expect-of-an-advanced-level-module.adoc index dcfd280..e4a37be 100755 --- a/docs/00a-preamble/01-what-to-expect-of-an-advanced-level-module.adoc +++ b/docs/00a-preamble/01-what-to-expect-of-an-advanced-level-module.adoc @@ -13,5 +13,3 @@ Das Modul kann unabhängig von einer CPSA-F-Zertifizierung besucht werden. - The certification is done as an assignment. The assessment and oral exam is conducted by experts appointed by the iSAQB. // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/00a-preamble/02-advanced-level-knowledge.adoc b/docs/00a-preamble/02-advanced-level-knowledge.adoc index aae5631..9d5683e 100755 --- a/docs/00a-preamble/02-advanced-level-knowledge.adoc +++ b/docs/00a-preamble/02-advanced-level-knowledge.adoc @@ -19,5 +19,3 @@ CPSA-A graduates can: - Control and execute architecture-relevant communication in medium to large development teams // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/00a-preamble/03-prerequisites.adoc b/docs/00a-preamble/03-prerequisites.adoc index d667fd1..54e9d60 100755 --- a/docs/00a-preamble/03-prerequisites.adoc +++ b/docs/00a-preamble/03-prerequisites.adoc @@ -24,5 +24,3 @@ image:00-preamble/cpsa-a-logo.png[pdfwidth=50%,align=center,alt="Certified Professional for Software Architecture^(R)^ Advanced Level (CPSA-A)"] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/00a-preamble/preface-ireb.adoc b/docs/00a-preamble/preface-ireb.adoc index 9e9c27a..b714d58 100755 --- a/docs/00a-preamble/preface-ireb.adoc +++ b/docs/00a-preamble/preface-ireb.adoc @@ -30,5 +30,3 @@ Chairman the Executive Board of IREB // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/00b-basics/01-what-to-expect-of-this-module.adoc b/docs/00b-basics/01-what-to-expect-of-this-module.adoc index b5b1c51..d94e751 100755 --- a/docs/00b-basics/01-what-to-expect-of-this-module.adoc +++ b/docs/00b-basics/01-what-to-expect-of-this-module.adoc @@ -16,5 +16,3 @@ They should either know how to elicit requirements (in agile and iterative appro // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc b/docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc index 8c867e5..81b554d 100755 --- a/docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc +++ b/docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc @@ -61,14 +61,3 @@ |=== // end::EN[] - -// tag::REMARK[] -[NOTE] -==== -Bitte die oben angegebene Tabelle entsprechend anpassen. - -= = = - -Please adjust the table above according to your curriculum. -==== -// end::REMARK[] diff --git a/docs/00b-basics/03-timing-didactics-and-more.adoc b/docs/00b-basics/03-timing-didactics-and-more.adoc index 6267c04..3e308db 100755 --- a/docs/00b-basics/03-timing-didactics-and-more.adoc +++ b/docs/00b-basics/03-timing-didactics-and-more.adoc @@ -1,7 +1,3 @@ -// tag::REMARK[] - -// end::REMARK[] - :recommended-duration-in-days: 3 :methodical-credits: 20 :technical-credits: 0 diff --git a/docs/00b-basics/04-prerequisites-for-this-training.adoc b/docs/00b-basics/04-prerequisites-for-this-training.adoc index b64c731..be95fdc 100755 --- a/docs/00b-basics/04-prerequisites-for-this-training.adoc +++ b/docs/00b-basics/04-prerequisites-for-this-training.adoc @@ -8,6 +8,3 @@ // end::EN[] -// tag::REMARK[] - -// end::REMARK[] diff --git a/docs/00b-basics/05-curriculum-outline.adoc b/docs/00b-basics/05-curriculum-outline.adoc index aa2a268..6c2f04e 100755 --- a/docs/00b-basics/05-curriculum-outline.adoc +++ b/docs/00b-basics/05-curriculum-outline.adoc @@ -22,5 +22,3 @@ The individual sections of the curriculum are described according to the followi This section therefore also outlines the skills to be acquired in corresponding training courses. // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/00b-basics/06-complementary-information.adoc b/docs/00b-basics/06-complementary-information.adoc index 145a4dd..344e081 100755 --- a/docs/00b-basics/06-complementary-information.adoc +++ b/docs/00b-basics/06-complementary-information.adoc @@ -19,5 +19,3 @@ To the extent necessary for understanding the curriculum, we have added definiti You find the most recent version of this document online (https://isaqb-org.github.io/curriculum-req4arc/), where you are encouraged to provide feedback. // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/01-Intro-and-Motivation/01-duration-terms.adoc b/docs/01-Intro-and-Motivation/01-duration-terms.adoc index a136989..e6eeeb7 100755 --- a/docs/01-Intro-and-Motivation/01-duration-terms.adoc +++ b/docs/01-Intro-and-Motivation/01-duration-terms.adoc @@ -16,5 +16,3 @@ Architecturally significant requirements (ASR), Agile Requirements Engineering // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/01-Intro-and-Motivation/02-learning-goals.adoc b/docs/01-Intro-and-Motivation/02-learning-goals.adoc index e0b4942..35a8f02 100644 --- a/docs/01-Intro-and-Motivation/02-learning-goals.adoc +++ b/docs/01-Intro-and-Motivation/02-learning-goals.adoc @@ -38,9 +38,4 @@ wie wichtig einzelne Aspekte des Lernziels sind. Es kann hier bereits auf Litera // end::EN[] -// tag::REMARK[] -[NOTE] -==== -Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren. -==== -// end::REMARK[] + diff --git a/docs/02-Clean-Start/01-duration-terms.adoc b/docs/02-Clean-Start/01-duration-terms.adoc index 5b86206..84f48a8 100755 --- a/docs/02-Clean-Start/01-duration-terms.adoc +++ b/docs/02-Clean-Start/01-duration-terms.adoc @@ -25,6 +25,4 @@ Vision, Business Goals, Stakeholders, Scope, Context, SMART, PAM // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/02-Clean-Start/02-learning-goals.adoc b/docs/02-Clean-Start/02-learning-goals.adoc index 2e65c35..e74d150 100644 --- a/docs/02-Clean-Start/02-learning-goals.adoc +++ b/docs/02-Clean-Start/02-learning-goals.adoc @@ -58,9 +58,4 @@ wie wichtig einzelne Aspekte des Lernziels sind. Es kann hier bereits auf Litera // end::EN[] -// tag::REMARK[] -[NOTE] -==== -Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren. -==== -// end::REMARK[] + diff --git a/docs/03-Functional-Requirements/01-duration-terms.adoc b/docs/03-Functional-Requirements/01-duration-terms.adoc index 2e5e000..9a8e72b 100755 --- a/docs/03-Functional-Requirements/01-duration-terms.adoc +++ b/docs/03-Functional-Requirements/01-duration-terms.adoc @@ -24,5 +24,3 @@ Functional Requirements, Uses Case, Epic, Feature, Story, Scenario, Acceptance C // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/03-Functional-Requirements/02-learning-goals.adoc b/docs/03-Functional-Requirements/02-learning-goals.adoc index 2d91a9f..ee20e62 100644 --- a/docs/03-Functional-Requirements/02-learning-goals.adoc +++ b/docs/03-Functional-Requirements/02-learning-goals.adoc @@ -91,9 +91,4 @@ Understand that many different criteria can be applied to decompose a system int // end::EN[] -// tag::REMARK[] -[NOTE] -==== -Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren. -==== -// end::REMARK[] + diff --git a/docs/04-Quality-Requirements/01-duration-terms.adoc b/docs/04-Quality-Requirements/01-duration-terms.adoc index a576992..9373977 100755 --- a/docs/04-Quality-Requirements/01-duration-terms.adoc +++ b/docs/04-Quality-Requirements/01-duration-terms.adoc @@ -23,6 +23,4 @@ Quality Requirement, Constraint, Non-functional Requirement // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/05-Behavior-Driven-Development/01-duration-terms.adoc b/docs/05-Behavior-Driven-Development/01-duration-terms.adoc index 5b8ed33..cd65c1a 100755 --- a/docs/05-Behavior-Driven-Development/01-duration-terms.adoc +++ b/docs/05-Behavior-Driven-Development/01-duration-terms.adoc @@ -21,6 +21,4 @@ Behaviour Driven Development (BDD), Automated Testing, Given-When-Then (GWT) // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/06-Prioritization/01-duration-terms.adoc b/docs/06-Prioritization/01-duration-terms.adoc index 814bf09..10f9657 100755 --- a/docs/06-Prioritization/01-duration-terms.adoc +++ b/docs/06-Prioritization/01-duration-terms.adoc @@ -21,5 +21,3 @@ Business value, risk, ranking, prioritization, affinity estimation, wall estimat // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/07-REQ-ARCH-development-process/01-duration-terms.adoc b/docs/07-REQ-ARCH-development-process/01-duration-terms.adoc index 6638bff..42b2d88 100755 --- a/docs/07-REQ-ARCH-development-process/01-duration-terms.adoc +++ b/docs/07-REQ-ARCH-development-process/01-duration-terms.adoc @@ -20,6 +20,4 @@ Design Thinking, Design Sprint, Lean Startup, Requirements Documentation, Tracea // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/08-Tools/00-structure.adoc b/docs/08-Tools/00-structure.adoc index 6646e2f..c59503b 100755 --- a/docs/08-Tools/00-structure.adoc +++ b/docs/08-Tools/00-structure.adoc @@ -16,5 +16,3 @@ include::02-learning-goals.adoc[] // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/08-Tools/01-duration-terms.adoc b/docs/08-Tools/01-duration-terms.adoc index 58c1020..d442deb 100755 --- a/docs/08-Tools/01-duration-terms.adoc +++ b/docs/08-Tools/01-duration-terms.adoc @@ -16,6 +16,4 @@ It is not intended to go into details of any of these tools. // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/42-glossary/00-glossary.adoc b/docs/42-glossary/00-glossary.adoc index 4996ba1..c87807d 100755 --- a/docs/42-glossary/00-glossary.adoc +++ b/docs/42-glossary/00-glossary.adoc @@ -1,19 +1,3 @@ -// header file for Req4Arc Glossary -// (c) iSAQB e.V. (https://isaqb.org) -// ==================================================== - - - -// tag::REMARK[] -[NOTE] -==== -* GS, Dec. 2019: added additional terms from Confluence -* GS, Oct. 2019: The glossary is currently maintained in EN (English) only. -* For an example for cross-references within the glossary, see the "Gherkin". -We don't currently use AsciiDoc cross-references, but stick to "->" symbols instead. -==== -// end::REMARK[] - // tag::DE[] // end::DE[] @@ -71,7 +55,7 @@ It was invented by Dan North as part of ->BDD (behavior-driven development). Non-functional Requirement:: (NFA) A -> quality requirement or a constraint. -PAM:: The acronym for _Purpose, Advantage, Metric_ helps to concentrate on important aspects when writing vision or business goal statements +PAM:: The acronym for _Purpose, Advantage, Metric_ helps to concentrate on important aspects when writing vision or business goal statements Quality Requirement:: A requirement that pertains to a quality concern that is not covered by functional requirements. @@ -102,5 +86,3 @@ It reflects Customer and stakeholder needs, as well as the Feature and Capabilit // end::EN[] - - diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index bd2e365..e69fab7 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -97,7 +97,5 @@ xp123.com/Articles/invest-in-good-stories-and-smart-tasks, 2003 // end::EN[] -// tag::REMARK[] -// end::REMARK[] diff --git a/docs/config/setup.adoc b/docs/config/setup.adoc index 27bbd18..2e4b604 100755 --- a/docs/config/setup.adoc +++ b/docs/config/setup.adoc @@ -2,14 +2,6 @@ :icons: font :sectnumlevels: 2 :imagesdir: images - -// if the attribute ":withRemarks:" is set, we amend every content-include -// by ";REMARK", so that the sections tagged "REMARK" are always included. -:withRemarks!: -:remarks: -ifdef::withRemarks[] -:remarks: ;REMARK -endif::withRemarks[] :!chapter-signifier: // ":language:" denotes the language or the target document. @@ -17,9 +9,8 @@ endif::withRemarks[] :language: EN // ":include_configuration:" always consists of the language, optionally -// followed by ";REMARK" // additional markers might be configured here! -:include_configuration: tags=**;{language}{remarks};!* +:include_configuration: tags=**;{language};!* :curriculum-short: REQ4ARC @@ -32,16 +23,3 @@ ifeval::["{language}" == "EN"] :curriculum-name: Requirements for Software Architects :curriculum-header-title: iSAQB Curriculum for Advanced Level: {curriculum-short} endif::[] - -// you might want to output some internal information... -ifdef::debug_adoc[] -[NOTE] -==== -Current configuration: - -* Language(s): {language} -* Document version: {document-version} -* Include-configuration: {include_configuration} - -==== -endif::debug_adoc[] diff --git a/scripts/includeLearningObjectives.gradle b/scripts/includeLearningObjectives.gradle index e072584..c11c1b0 100644 --- a/scripts/includeLearningObjectives.gradle +++ b/scripts/includeLearningObjectives.gradle @@ -89,13 +89,10 @@ ext.writeLearningObjectives = { contentDE, contentEN -> println "Learning objectives file: " + outFile.getAbsolutePath() - final String EMPTYRemark = """// tag::REMARK[]\n// end::REMARK[]\n""" - outFile.withWriter('UTF-8') { writer -> writer.writeLine("// this is autogenerated - please do not modify manually!\n") writer.writeLine(contentDE) writer.writeLine(contentEN) - writer.writeLine(EMPTYRemark) } }