jQA logo

This site contains a collection of short tutorials on jQAssistant. These tutorials are intended to support users of jQAssistant in their daily work and outline best practices. For more information and documentation visit https://jqassistant.org.

There’s an interesting use case you’re missing in this list? Let us know and create a request here!

Architecture & Design Rules

Getting started with jQAssistant, Spring Boot and Maven

Integration of jQAssistant into a Spring Boot project which is built using Apache Maven.

Getting started with jQAssistant and Domain Driven Design

Demonstrates how to map DDD concepts in the code to the graph and apply constraints using the DDD plugin,

Getting started with jQAssistant in a Maven Project

This tutorial shows you how you can use jQAssistant in a Maven project by integrating the jQAssistant Plugin.

Manage Package Dependencies

Define and verify allowed dependencies between components that are represented by package structures.

Generate Reports About Structures and Metrics

Generate HTML reports from Asciidoc documents including rules and embed results as tables, diagrams or CSV files.

Enforce Usage Of A Logging API

Enforce usage of a specific logging API like Slf4j in an application and avoid usage of unwanted frameworks.

Documenting and Securing architecture decisions with ADRs and jQAssistant

Demonstrates how Architecture Decision Records can be enhanced with jQAssistant.

Exploration & Analysis

Analyzing Java’s Annotations with jQAssistant

This tutorial shows you how you can analyse Java annotations using jQAssistant.

Calculate Metrics

Describes how to calculate some common metrics.


Using 3rd-party Plugins

Demonstrates using 3rd-party plugins for the jQAssistant Maven plugin and command line utility.

Sharing Rules Between Projects

Create a plugin containing shared rules for using them in different projects.

Implementation Of A Scanner Plugin

Demonstrates the implementation of a scanner plugin.

Tool Integration

Reporting jQAssistant Results In Jenkins

Describes the setup for reporting the status of jQAssistant rules as test results in Jenkins CI.

Setting Up A Team Server

Describes the jQAssistant setup for using a remote Neo4j server within a CI build to provide teams a shared instance for exploration and analysis of their project.