From 9e8b81680376f9957a592d5f63e75d1909c4a4b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Z=C3=B6rner?= Date: Mon, 16 Sep 2024 13:33:35 +0200 Subject: [PATCH 1/6] Write author names the same way e.g. "S. Brown" (instead of "Brown, S." or "Simon Brown"). Plus: use same way of writing "et al." and order of editions and publishing dates --- docs/99-references/00-references.adoc | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index 2305f36..ab09a6b 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -12,27 +12,27 @@ Dieser Abschnitt enthält Quellenangaben, die ganz oder teilweise im Curriculum This section contains references that are cited in the curriculum. // end::EN[] -- [[[bachmann,Bachmann 2000]]] Bachmann, F., L. Bass, et al.: Software Architecture Documentation in Practice. Software Engineering Institute, CMU/SEI-2000-SR-004. +- [[[bachmann,Bachmann 2000]]] F. Bachmann, L. Bass et al.: Software Architecture Documentation in Practice. Software Engineering Institute, CMU/SEI-2000-SR-004. -- [[[bass,Bass 2021]]] Bass, L., Clements, P. und Kazman, R.: Software Architecture in Practice. 4. Edition, Addison-Wesley 2021. +- [[[bass,Bass 2021]]] L. Bass, P. Clements und R. Kazman: Software Architecture in Practice. 4. Edition, Addison-Wesley 2021. -- [[[brown-c4,Brown (C4)]]] Brown, S.:, R.: The C4 model for visualising software architecture. Leanpub +- [[[brown-c4,Brown (C4)]]] S. Brown: The C4 model for visualising software architecture. Leanpub -- [[[brown-sg,Brown (Guidebook)]]] Brown, S.:, R.: The software guidebook. A guide to documenting your software architecture. Leanpub +- [[[brown-sg,Brown (Guidebook)]]] S. Brown: The software guidebook. A guide to documenting your software architecture. Leanpub -- [[[clements,Clements+2010]]] Clements, P., F. Bachmann, L. Bass, D. Garlan, J. Ivers et al: Documenting Software Architectures – Views and Beyond. 2. Edition, Addison Wesley 2010. +- [[[clements,Clements+2010]]] P. Clements, F. Bachmann, L. Bass, D. Garlan, J. Ivers et al.: Documenting Software Architectures – Views and Beyond. 2. Edition 2010, Addison Wesley. -- [[[hargis,Hargis+2004]]] Hargis, Gretchen et. al: Quality Technical Information: A Handbook for Writers and Editors. Prentice Hall, IBM Press, 2004. +- [[[hargis,Hargis+2004]]] G. Hargis et al.: Quality Technical Information: A Handbook for Writers and Editors. Prentice Hall, IBM Press, 2004. -- [[[kruchten,Kruchten 1995]]] Kruchten, P.: Architectural Blueprints – The 4-1 View Model of Architecture. IEEE Software November 1995; 12(6), p. 42-50. +- [[[kruchten,Kruchten 1995]]] P. Kruchten: Architectural Blueprints – The 4-1 View Model of Architecture. IEEE Software November 1995; 12(6), p. 42-50. -- [[[nygard,Nygard]]] Nygard, Michael: Documenting Architecture Decision. . See also +- [[[nygard,Nygard]]] M. Nygard: Documenting Architecture Decisions. . See also -- [[[starke,Starke 2024]]] Starke, Gernot: Effektive Softwarearchitekturen - Ein praktischer Leitfaden. 10. Auflage 2024, Carl Hanser Verlag, München. +- [[[starke,Starke 2024]]] G. Starke: Effektive Softwarearchitekturen - Ein praktischer Leitfaden. 10. Auflage 2024, Carl Hanser Verlag, München. -- [[[starkehruschka,Starke+2016]]] Gernot Starke, Peter Hruschka: Communicating Software Architectures: lean, effective and painless documentation. +- [[[starkehruschka,Starke+2016]]] G. Starke, P. Hruschka: Communicating Software Architectures: lean, effective and painless documentation. Leanpub  - [[[UML,UML]]] Universal Modeling Language, homepage: . Provides both the standard plus a collection of resources for further information. -- [[[zoerner, Zörner 2021]]] Stefan Zörner: Softwarearchitekturen dokumentieren und kommunizieren: Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten. 3. Auflage, Carl-Hanser Verlag 2021 +- [[[zoerner, Zörner 2021]]] S. Zörner: Softwarearchitekturen dokumentieren und kommunizieren: Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten. 3. Auflage 2021, Carl-Hanser Verlag. From a6d20bc98892bdd48c34769b99d1fc045be2e3e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Z=C3=B6rner?= Date: Mon, 16 Sep 2024 14:05:19 +0200 Subject: [PATCH 2/6] Add letters to organize references (as in SOFT) --- docs/99-references/00-references.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index ab09a6b..b000884 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -12,6 +12,8 @@ Dieser Abschnitt enthält Quellenangaben, die ganz oder teilweise im Curriculum This section contains references that are cited in the curriculum. // end::EN[] +**B** + - [[[bachmann,Bachmann 2000]]] F. Bachmann, L. Bass et al.: Software Architecture Documentation in Practice. Software Engineering Institute, CMU/SEI-2000-SR-004. - [[[bass,Bass 2021]]] L. Bass, P. Clements und R. Kazman: Software Architecture in Practice. 4. Edition, Addison-Wesley 2021. @@ -20,19 +22,33 @@ This section contains references that are cited in the curriculum. - [[[brown-sg,Brown (Guidebook)]]] S. Brown: The software guidebook. A guide to documenting your software architecture. Leanpub +**C** + - [[[clements,Clements+2010]]] P. Clements, F. Bachmann, L. Bass, D. Garlan, J. Ivers et al.: Documenting Software Architectures – Views and Beyond. 2. Edition 2010, Addison Wesley. +**H** + - [[[hargis,Hargis+2004]]] G. Hargis et al.: Quality Technical Information: A Handbook for Writers and Editors. Prentice Hall, IBM Press, 2004. +**K** + - [[[kruchten,Kruchten 1995]]] P. Kruchten: Architectural Blueprints – The 4-1 View Model of Architecture. IEEE Software November 1995; 12(6), p. 42-50. +**N** + - [[[nygard,Nygard]]] M. Nygard: Documenting Architecture Decisions. . See also +**S** + - [[[starke,Starke 2024]]] G. Starke: Effektive Softwarearchitekturen - Ein praktischer Leitfaden. 10. Auflage 2024, Carl Hanser Verlag, München. - [[[starkehruschka,Starke+2016]]] G. Starke, P. Hruschka: Communicating Software Architectures: lean, effective and painless documentation. Leanpub  +**U** + - [[[UML,UML]]] Universal Modeling Language, homepage: . Provides both the standard plus a collection of resources for further information. +**Z** + - [[[zoerner, Zörner 2021]]] S. Zörner: Softwarearchitekturen dokumentieren und kommunizieren: Entwürfe, Entscheidungen und Lösungen nachvollziehbar und wirkungsvoll festhalten. 3. Auflage 2021, Carl-Hanser Verlag. From 3ea33cf1f87bb5ac8c5f0d4d670ec67b8a067032 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Z=C3=B6rner?= Date: Mon, 16 Sep 2024 14:59:44 +0200 Subject: [PATCH 3/6] Add publishing Year to M. Nygard --- docs/99-references/00-references.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index b000884..3400d9d 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -36,7 +36,7 @@ This section contains references that are cited in the curriculum. **N** -- [[[nygard,Nygard]]] M. Nygard: Documenting Architecture Decisions. . See also +- [[[nygard,Nygard 2011]]] M. Nygard: Documenting Architecture Decisions. Blog Post 2011 https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions. See also https://adr.github.io/ **S** From 5dd14980dd9671a720f410040924c3542d86505f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Z=C3=B6rner?= Date: Mon, 16 Sep 2024 15:09:46 +0200 Subject: [PATCH 4/6] Publishing year for Special Report CMU/SEI-2000-SR-004 added --- docs/99-references/00-references.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index 3400d9d..d7e6dc8 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -14,7 +14,7 @@ This section contains references that are cited in the curriculum. **B** -- [[[bachmann,Bachmann 2000]]] F. Bachmann, L. Bass et al.: Software Architecture Documentation in Practice. Software Engineering Institute, CMU/SEI-2000-SR-004. +- [[[bachmann,Bachmann 2000]]] F. Bachmann, L. Bass et al.: Software Architecture Documentation in Practice. Software Engineering Institute, Special Report 2000, CMU/SEI-2000-SR-004. - [[[bass,Bass 2021]]] L. Bass, P. Clements und R. Kazman: Software Architecture in Practice. 4. Edition, Addison-Wesley 2021. From 4e719b740c924ace596e0a449d67ee1daae2586d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Z=C3=B6rner?= Date: Mon, 16 Sep 2024 15:55:05 +0200 Subject: [PATCH 5/6] Remove <..> from URLs in references. --- docs/99-references/00-references.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index d7e6dc8..b537590 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -18,9 +18,9 @@ This section contains references that are cited in the curriculum. - [[[bass,Bass 2021]]] L. Bass, P. Clements und R. Kazman: Software Architecture in Practice. 4. Edition, Addison-Wesley 2021. -- [[[brown-c4,Brown (C4)]]] S. Brown: The C4 model for visualising software architecture. Leanpub +- [[[brown-c4,Brown (C4)]]] S. Brown: The C4 model for visualising software architecture. Leanpub https://leanpub.com/visualising-software-architecture -- [[[brown-sg,Brown (Guidebook)]]] S. Brown: The software guidebook. A guide to documenting your software architecture. Leanpub +- [[[brown-sg,Brown (Guidebook)]]] S. Brown: The software guidebook. A guide to documenting your software architecture. Leanpub https://leanpub.com/documenting-software-architecture **C** @@ -43,11 +43,11 @@ This section contains references that are cited in the curriculum. - [[[starke,Starke 2024]]] G. Starke: Effektive Softwarearchitekturen - Ein praktischer Leitfaden. 10. Auflage 2024, Carl Hanser Verlag, München. - [[[starkehruschka,Starke+2016]]] G. Starke, P. Hruschka: Communicating Software Architectures: lean, effective and painless documentation. -Leanpub  +Leanpub https://leanpub.com/arc42inpractice **U** -- [[[UML,UML]]] Universal Modeling Language, homepage: . Provides both the standard plus a collection of resources for further information. +- [[[UML,UML]]] Universal Modeling Language, homepage: https://www.uml.org. Provides both the standard plus a collection of resources for further information. **Z** From e091e2403c5bc0c05cc6556c3fc7dda904cb4745 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stefan=20Z=C3=B6rner?= Date: Mon, 16 Sep 2024 16:01:38 +0200 Subject: [PATCH 6/6] Remove Bachmann 2000 from References See Issue https://github.com/isaqb-org/curriculum-adoc/issues/30 --- docs/99-references/00-references.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/99-references/00-references.adoc b/docs/99-references/00-references.adoc index b537590..b086c36 100755 --- a/docs/99-references/00-references.adoc +++ b/docs/99-references/00-references.adoc @@ -14,8 +14,6 @@ This section contains references that are cited in the curriculum. **B** -- [[[bachmann,Bachmann 2000]]] F. Bachmann, L. Bass et al.: Software Architecture Documentation in Practice. Software Engineering Institute, Special Report 2000, CMU/SEI-2000-SR-004. - - [[[bass,Bass 2021]]] L. Bass, P. Clements und R. Kazman: Software Architecture in Practice. 4. Edition, Addison-Wesley 2021. - [[[brown-c4,Brown (C4)]]] S. Brown: The C4 model for visualising software architecture. Leanpub https://leanpub.com/visualising-software-architecture