arc42-lint

Detect cross-section ID inconsistencies in arc42 documentation.

20|3|Updated Nov 9, 2025
One-click install
npx skills add https://github.com/MSiccDev/arc42-toolkit --skill arc42-lint
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: arc42-lint
Source: https://github.com/MSiccDev/arc42-toolkit/tree/main/skills/arc42-lint
Command: npx skills add https://github.com/MSiccDev/arc42-toolkit --skill arc42-lint

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps arc42 documentation consistent by validating cross-section references and ID mappings across the full template.

Core Features & Use Cases

  • Validates IF-xx interface IDs between Section 3 and Section 5
  • Verifies Q42 tag traceability between Section 1.2 and Section 10
  • Checks ADR risk references against Section 11 risk matrix
  • Ensures aspirational scenarios in Section 10.3 are linked in Section 11
  • Runs automated linting when a script is present, otherwise applies rules manually

Quick Start

Run the arc42-lint tool to verify cross-section consistency across your architecture documentation.

Frequently Asked Questions about arc42-lint

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check arc42 documentation for cross-section consistency?

To check arc42 documentation consistency, validate cross-section references like IF-xx, QS-xx, ADR, and RISK-xx IDs. This ensures interface IDs, deployment mappings, and quality goals remain aligned across all template sections.

How do I validate interface IDs between arc42 sections?

Validate interface IDs by checking IF-xx references between Section 3 and Section 5. This cross-section linting ensures building block interfaces map correctly to deployment views without manual cross-referencing.

Does arc42 linting work without an automated script?

Arc42 linting works manually when automation is unavailable. Rules can be applied directly to verify Q42 tag traceability, ADR risk references, and aspirational scenario links without running the Python script.

What is the best way to trace Q42 tags across arc42 quality goals?

The best way to trace Q42 tags is verifying their consistency between Section 1.2 and Section 10. This cross-section check ensures quality goals map directly to quality scenarios.

How do I verify ADR risk references against the arc42 risk matrix?

Verify ADR risk references by checking them against the Section 11 risk matrix. This ensures RISK-xx IDs in architecture decisions align with documented risks and aspirational scenarios in Section 10.3.

When should I manually apply arc42 linting rules instead of automating?

Manually apply arc42 linting rules when automation is unavailable or the Python script is absent. This allows validating cross-section ID mappings and interface consistency without script execution.