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 |
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 ( |
Core Module |
(v3 — being retired in v4, ADR-12.) The |
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 |
ConfigObject |
Groovy’s native configuration object, produced by parsing |
ConfigService |
Wrapper around |
Microsite |
A complete static documentation website generated by docToolchain’s built-in static site generator ( |
inputFiles |
Configuration array in |
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 ( |
ADR |
Architecture Decision Record. A lightweight document capturing a significant architecture decision, its context, rationale, and consequences. Follows Nygard’s format. Stored in |
Confluence Storage Format |
The XHTML-based markup language used by Atlassian Confluence to store page content. Includes Confluence-specific macros ( |
HtmlTransformer |
The class responsible for converting AsciiDoctor-generated HTML5 into Confluence Storage Format. Chains through |
JQL |
Jira Query Language. A SQL-like query language used to search for Jira issues. Used in |
Headless Mode |
Non-interactive execution mode for CI/CD pipelines. Activated via |
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 |
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 |
Groovy Grape |
Groovy’s built-in dependency manager. Scripts declare dependencies via |
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. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.