architecture-glossary

Organize domain vocabulary across architecture, code, and UI with cross-referenced glossary entries.

Updated Jan 5, 2025
One-click install
npx skills add https://github.com/pkuppens/pkuppens --skill architecture-glossary
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: architecture-glossary
Source: https://github.com/pkuppens/pkuppens/tree/main/skills/architecture/architecture-glossary
Command: npx skills add https://github.com/pkuppens/pkuppens --skill architecture-glossary

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Maintains ubiquitous language — shared vocabulary across architecture, code, and UI. Aligns terms with arc42 §12 to reduce ambiguity in design, development, and governance. Supports onboarding and architecture reviews by providing consistent terminology references.

Core Features & Use Cases

  • Define and maintain domain concepts with precise definitions.
  • Cross-reference terms, ADRs, and related concepts to ensure consistency.
  • Facilitate onboarding and architecture governance by offering a searchable glossary.

Quick Start

Create or update glossary entries using the defined format in the architecture glossary documentation.

Frequently Asked Questions about architecture-glossary

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

FAQPage Schema
What is ubiquitous language in software architecture and why do I need a glossary for it?

Ubiquitous language is a shared vocabulary across architecture, code, and UI that reduces ambiguity. You need a glossary to align domain terminology, ensuring consistent design, development, and governance across teams.

How do I organize and standardize domain terminology across architecture docs and code?

To organize domain terminology, define glossary entries with precise definitions and cross-reference related terms and ADRs. Standardize placement within architecture documentation, aligning with arc42 section 12 for consistency.

Can I use a glossary to support onboarding and architecture reviews?

Yes, a glossary supports onboarding and architecture reviews by providing a searchable terminology reference. It ensures new team members and reviewers have consistent definitions, cross-references, and related concepts readily available.

What's the best way to align domain terms with ADRs and arc42 documentation?

The best way to align domain terms with ADRs and arc42 is to enforce a standardized glossary format within section 12. Cross-reference terminology entries directly with ADRs to resolve ambiguity and maintain consistency across documentation.

When should I create terminology ADRs to resolve ambiguity in domain concepts?

You should create terminology ADRs when domain concepts lack precise definitions or when terms conflict across architecture, code, and UI. Cross-reference these ADRs with glossary entries to enforce consistent ubiquitous language.

Does the architecture-glossary format work for cross-referencing related terms and concepts?

Yes, the architecture-glossary format supports cross-referencing related terms, ADRs, and domain concepts. It enforces a structured format and placement in docs, ensuring consistent terminology alignment across architecture, code, and UI layers.