Glossary

Term Definition

dtcw

docToolchain wrapper. Cross-platform CLI entry point (Bash, PowerShell, Batch) that abstracts environment detection and Java installation. In v4 it builds the classpath from the lib/ directory and invokes the Groovy task scripts directly — there is no Gradle (ADR-3). The primary interface for all docToolchain operations; the v4 wrapper is dtcw4.

Docs-as-code

Methodology that treats documentation like source code: written in plain text (AsciiDoc), stored in version control, peer-reviewed via pull requests, and built automatically by CI/CD pipelines.

Script Plugin

(v3 — removed in v4, ADR-3.) A Gradle script file (scripts/.gradle) that registered one or more Gradle tasks for a specific feature (e.g., exportJiraIssues.gradle), applied via apply from: in build.gradle. In v4 each task is a self-contained Groovy script (scripts/.groovy) run directly, with no Gradle.

Core Module

(v3 — being retired in v4, ADR-12.) The core/ subproject containing business logic as a standalone Groovy library. In v4 task logic moves back into scripts/lib/ Groovy sources loaded at runtime; the compiled module is no longer on the runtime classpath.

Shadow JAR

(v3 — removed in v4, ADR-7.) A fat JAR that bundled all runtime dependencies into a single artifact for the Core Module. v4 ships its dependencies as individual JARs in the lib/ directory instead.

ConfigObject

Groovy’s native configuration object, produced by parsing docToolchainConfig.groovy via ConfigSlurper. Provides nested map-like access to configuration properties.

ConfigService

Wrapper around ConfigObject providing property access via dot-notation paths (e.g., get("confluence.api")) and subtree extraction. In v4 this is the script-loaded DtcConfig helper (scripts/lib/DtcConfig.groovy), which replaces the v3 compiled ConfigService.

Microsite

A complete static documentation website generated by docToolchain’s built-in static site generator (MicrositeBaker, ADR-4) from AsciiDoc sources and Groovy Server Page (GSP) templates. Includes navigation, search, theming, and multiple content sections. (v3 used jBake.)

inputFiles

Configuration array in docToolchainConfig.groovy that specifies which AsciiDoc files to process and in which output formats (e.g., [file: 'arc42/arc42.adoc', formats: ['html','pdf']]).

ancestorId

Confluence page ID used as the parent page when publishing documentation. Determines where in the Confluence page hierarchy new pages are created.

SDKMAN

Software Development Kit Manager. A tool for managing parallel versions of multiple SDKs. One of three supported installation methods for docToolchain (sdk install doctoolchain).

ADR

Architecture Decision Record. A lightweight document capturing a significant architecture decision, its context, rationale, and consequences. Follows Nygard’s format. Stored in src/docs/arc42/adrs/ and included from Chapter 9.

Confluence Storage Format

The XHTML-based markup language used by Atlassian Confluence to store page content. Includes Confluence-specific macros (<ac:structured-macro>) and resource identifiers (<ri:attachment>). The HtmlTransformer converts AsciiDoctor HTML5 output into this format.

HtmlTransformer

The class responsible for converting AsciiDoctor-generated HTML5 into Confluence Storage Format. Chains through CodeBlockTransformer and LinkTransformer for specialized transformations.

JQL

Jira Query Language. A SQL-like query language used to search for Jira issues. Used in docToolchainConfig.groovy to define which issues to export (e.g., project='KEY' AND status='Done').

Headless Mode

Non-interactive execution mode for CI/CD pipelines. Activated via DTC_HEADLESS=true environment variable or absence of a TTY. Suppresses all interactive prompts and auto-accepts defaults.

Quality Scenario

A concrete, measurable acceptance criterion for an architecture quality goal. Defined in Section 10 and referenced by all ADRs to evaluate architectural tradeoffs.

streamingExecute

A Groovy helper method used in scripts to invoke external processes (e.g., VBScript, shell commands) with real-time console output streaming. Manages process lifecycle and output capture.

MCP (Model Context Protocol)

A protocol for communication between LLMs and external tools. daCLI implements an MCP server that exposes 10 tools for structured document access via stdio transport. Enables LLMs to navigate, search, and modify documentation.

Semantic Anchors

Well-defined terms, methodologies, and frameworks that serve as precise reference points when communicating with LLMs. Examples: "SOLID Principles", "arc42", "Socratic Method", "MECE". Each anchor activates a rich, interconnected body of knowledge in the LLM. Quality criteria: Precise, Rich, Consistent, Attributable. See https://llm-coding.github.io/Semantic-Anchors/

Semantic Contracts

Bundles of Semantic Anchors composed into reusable working agreements. Defined in CLAUDE.md files. Example: "Specification = Use Cases with Activity Diagrams + Gherkin acceptance criteria". Contracts ensure consistent collaboration conventions between humans and LLMs across a project. See https://llm-coding.github.io/Semantic-Anchors/#/contracts

daCLI

Documentation Access CLI. A Python-based tool providing both a command-line interface and an MCP server for structured document access. Builds an in-memory index from AsciiDoc/Markdown sources for O(1) section lookups. 10 MCP tools for navigation, search, and modification.

Bausteinsicht

Architecture-as-code tool (Go). Defines architecture in JSONC text files with bidirectional draw.io synchronization. LLMs read/write JSONC natively. Exports PlantUML, Mermaid, PNG for embedding in AsciiDoc.

Groovy SimpleTemplate

Groovy’s built-in template engine. Used for microsite HTML generation in v4 (replacing jBake’s template system). The 23 existing .gsp template files from v3 are compatible.

Groovy Grape

Groovy’s built-in dependency manager. Scripts declare dependencies via @Grab('group:artifact:version'). Automatically downloads JARs from Maven Central and caches them in ~/.groovy/grapes/. One of the options for dependency management in v4 (ADR-TBD-6).

Pugh Matrix

A structured decision-making technique used in ADRs. Criteria are scored on a 3-point scale (–1, 0, +1) for each alternative. The alternative with the highest total score wins.