Advanced-Curriculum "Requirements for Architects"

The goal of this module is to equip architects with enough requirements know-how, so that they can take educated architecture decisions, based on the real needs of stakeholders.

Status

This is copyrighted work.

Content

Architects and development teams often get only mediocre requirements as input for their work.  The goal of this module is to equip architects with enough requirements know-how, so that they can take educated architecture decisions, based on the real needs of stakeholders. They should either know how to elicit requirements (in agile and iterative approaches) or - at least - to know what to ask from others in their environment.

How to contribute or participate

Create an issue, a merge- or pull-request.

How to build locally

Prerequisite: Docker. Nothing else — no JDK, no Ruby.

Clone the repository (with submodules, for the license text):

git clone git@github.com:isaqb-org/REPO-NAME.git --recursive

If you already cloned without --recursive, run git submodule update --init --recursive.

Using make (Linux / macOS)

The Makefile wraps the build script with convenient targets. Each language target builds both formats (PDF + HTML). Run make (or make help) for the list:

make            # show all targets (same as `make help`)
make all        # both languages (DE + EN), PDF + HTML
make DE         # German, PDF + HTML
make EN         # English, PDF + HTML
make clean      # remove the build/ output directory

Using the build script directly

Build all languages and formats:

./curriculum-build.sh        # Linux / macOS
curriculum-build.bat         # Windows

Build a single output — pass the format and language (and optionally a variant):

./curriculum-build.sh pdf DE          # Linux / macOS
./curriculum-build.sh html EN
./curriculum-build.sh pdf DE REMARKS

curriculum-build.bat pdf DE           rem Windows
curriculum-build.bat html EN
curriculum-build.bat pdf DE REMARKS

Output is written to build/, named <CURRICULUM_FILE>-<lang>.pdf / .html, together with an index.html overview page. The launcher pulls the builder image on first run and reuses it afterwards.

Build configuration

build.config in the repository root holds the per-curriculum settings:

Key	Meaning
CURRICULUM_FILE	AsciiDoc root in docs/ (without .adoc); also the output file name.
LANGUAGES	Space-separated languages to build. Default DE EN; drop one for a single-language curriculum.
SUFFIX_TAGS	Space-separated extra build variants, exposed as the {suffix} attribute. Empty = single build.
PREPRESS	PDF print/book layout (recto chapter starts + binding margins). true / false.

Any key can be overridden for a single run via an environment variable, e.g. LANGUAGES="DE" ./curriculum-build.sh.

Maintainers

This repository is currently maintained by Gernot Starke.

Licensing and Copyright

license-copyright/LICENSE.adoc