skills.rest
shopwareLabs
shopwareLabsOFFICIAL
Explore all skills by this author →
WebsiteGitHub

adr-writing

Draft and validate Shopware Architecture Decision Records with YAML front matter.

41|5|Updated Oct 22, 2025
Search Tags:#architecture#documentation#writing#adr#guidelines#front-matter#shopware
One-click install
npx skills add https://github.com/shopwareLabs/ai-coding-tools --skill adr-writing-shopwarelabs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: adr-writing
Source: https://github.com/shopwareLabs/ai-coding-tools/tree/main/plugins/contributor-writing/skills/adr-writing
Command: npx skills add https://github.com/shopwareLabs/ai-coding-tools --skill adr-writing-shopwarelabs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Architecture Decision Records (ADRs) are essential for capturing architectural rationale, but teams often struggle to create consistent, standards-compliant ADRs. This Skill provides a guided workflow to draft and validate ADRs following Shopware ADR conventions, ensuring proper front matter, structure, and style.

Core Features & Use Cases

  • Create ADRs with correct YAML front matter and structure (simple or multi-domain)
  • Validate existing ADRs against required front matter rules, structure, and Shopware patterns
  • Use when user mentions "ADR", "architecture decision record", or "decision record" to trigger ADR workflows

Quick Start

Provide a topic and area to initiate an ADR drafting session with guided prompts and templates.

Frequently Asked Questions about adr-writing

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

FAQPage Schema
How do I write an Architecture Decision Record that follows Shopware conventions?▼

To write an Architecture Decision Record for Shopware, provide a topic and area to initiate a guided drafting session that enforces correct YAML front matter, structure, and style for publish-ready ADRs.

What YAML front matter is required for an Architecture Decision Record?▼

Architecture Decision Records require YAML front matter with title, date, area, and tags fields. This metadata ensures proper validation and supports simple or multi-domain structures.

How do I validate an existing Architecture Decision Record against required standards?▼

You can validate existing Architecture Decision Records by checking them against required front matter rules, structure, and Shopware patterns to ensure compliance and consistency.

When should I use a multi-domain structure for architecture documentation?▼

Use a multi-domain structure for architecture documentation when your ADRs span multiple areas, allowing guided content organization while maintaining consistent front matter and predefined patterns.

Do I need predefined patterns to draft architecture decision records?▼

Drafting architecture decision records references predefined patterns and styles to generate publish-ready drafts, ensuring your ADRs adhere to established guidelines without starting from scratch.

Related Skills

Explore More Software Engineering Skills→
tamago0224tamago0224

create-architectural-decision-record

Generate standardized Architectural Decision Records in Markdown with front matter and structured sections.

Community
Advanced
ranma2913ranma2913

create-architectural-decision-record

Generate structured Architectural Decision Records with front matter under /docs/adr.

Community
Advanced
stevolandstevoland

adr

Create and manage MADR-compliant Architecture Decision Records across projects.

Community
Basic
fabioabrfabioabr

adr-writer

Create and update Markdown Architecture Decision Records with validated front matter.

Community
Advanced