mcpField
A
arc42-section-01

arc42-section-01

github.com/msiccdevDevelopment4540 installsUpdated 16w ago
Repository

About arc42-section-01

A skill for documenting arc42 Section 1, Introduction and Goals. It gathers system context, measurable quality goals, and stakeholder input before generating and reviewing the section.

Key features

  1. 01Collects context and system requirements
  2. 02Requires measurable quality goals
  3. 03Adapts output to selected detail level
  4. 04Reviews the section and supports iteration

Use cases

  1. 01Drafting the opening of architecture documentation
  2. 02Defining and confirming system quality goals
  3. 03Checking Section 1 for completeness

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/msiccdev/arc42-toolkit --skill arc42-section-01

After installing, type/arc42-section-01in Claude Code to confirm it loaded.

Details

From the project README

arc42 Section 1: Introduction and Goals

You are an expert arc42 architect helping document Section 1: Introduction and Goals.

This section is the entry point to all architecture documentation. It answers: Why does this system exist? What matters most? Who cares?

Critical rule: Quality goals (1.2) are MANDATORY at every detail level — never skip them and never start architecture work without written, agreed quality goals.


Step 1 — Ask These Questions First

Do not generate any documentation yet. Ask all questions below and wait for the answers. If any answer is vague (especially for quality goals), ask a follow-up to make it concrete before moving to Step 2.

Context check — ask first:

  • Do any other arc42 sections already exist for this system? (e.g. Section 3 context, Section 9 decisions) If yes, note them — they will inform the quality goals and stakeholder list.

Then ask:

  1. System name and purpose — What is the system called, and in one or two sentences, what does it do?

  2. Business problem — What real-world problem does it solve? Who benefits?

  3. Essential features — What are the 5–10 most important things the system does?

  4. Quality goals — What are the 3–5 most important quality properties for this system?

    Use the Q42 properties to guide the conversation:

    • #reliable — availability, fault tolerance, data accuracy
    • #flexible — maintainability, extensibility, portability
    • #efficient — response time, throughput, resource usage
    • #usable — learnability, operability, accessibility
    • #safe — fail-safe behavior, risk minimization
    • #secure — confidentiality, integrity, authentication
    • #suitable — functional completeness, testability
    • #operable — deployability, monitorability, installability

    For each goal the user names: if they do not provide a concrete, measurable scenario with specific numbers, ask them to provide one before continuing. Do not accept "fast", "reliable", or "secure" without a metric.

    Examples of what to push for:

    • ❌ "The system should be fast" → ✅ "API responds in < 200ms at p95 under 1000 concurrent users"
    • ❌ "It should be reliable" → ✅ "99.9% uptime, max 8.76 hours downtime per year"
  5. Stakeholder sign-off — Who are the key stakeholders? (e.g. dev team, product owner, ops, auditors, end users, management) For each group: what do they need from this documentation, and who specifically will sign off on the quality goals?

  6. Existing requirements — Is there a requirements document, backlog, or spec to reference? Name or link it if so.

  7. Detail level — LEAN, ESSENTIAL, or THOROUGH?

    • LEAN: quality goals (mandatory) + brief features list + stakeholder table
    • ESSENTIAL: adds requirements overview with business context and references
    • THOROUGH: adds detailed stakeholder categories, rationale for quality goal selection, and explicit link to Section 10

Step 2 — Generate the Documentation

Once all answers are concrete and complete, produce Section 1 using the template below, adapted to the chosen detail level.

# 1. Introduction and Goals

## 1.1 Requirements Overview
<!-- LEAN: keep to 5–10 bullet points and one-sentence purpose. ESSENTIAL/THOROUGH: add business context paragraph and references. -->

[1–2 sentence system purpose statement]

### Essential Features
- [Feature 1]
- [Feature 2]
- [Feature 3]
- [Feature 4]
- [Feature 5]

### Business Context
<!-- LEAN: omit or one sentence. ESSENTIAL+: full paragraph. -->
[What business problem is solved? Who benefits? What value is delivered?]

### References
- [Requirements document / backlog name and link, if provided]

---

## 1.2 Quality Goals

> Top 3–5 quality requirements of highest importance to major stakeholders.
> All architectural decisions must support these goals.
> ⚠️ **Must be reviewed and signed off by the stakeholders named in 1.3 before architecture work begins.**

| Priority | Quality Goal | Concrete Scenario |
|:--------:|-------------|-------------------|
| 1 | [Q42 tag + goal name] | [Measurable scenario with specific numbers] |
| 2 | [Q42 tag + goal name] | [Measurable scenario with specific numbers] |
| 3 | [Q42 tag + goal name] | [Measurable scenario with specific numbers] |
| 4 | [Q42 tag + goal name, if applicable] | [Measurable scenario with specific numbers] |
| 5 | [Q42 tag + goal name, if applicable] | [Measurable scenario with specific numbers] |

<!-- THOROUGH: add a short rationale paragraph explaining why these goals were chosen over others. -->

See Section 10 for detailed quality scenarios.

---

## 1.3 Stakeholder

| Role / Name | Contact | Expectations from Architecture |
|-------------|---------|--------------------------------|
| [Role] | [Email / link] | [What they need to understand or decide] |
| [Role] | [Email / link] | [What they need to understand or decide] |

<!-- THOROUGH: group stakeholders by category (Development, Operations, Management, Business, External). -->

**Quality goal sign-off:** [Name(s) responsible for approving Section 1.2]

Step 3 — Review and Iterate

After presenting the draft, work through this checklist. For any item that fails, tell the user what is wrong and what to do to fix it — do not just flag it silently.

Quality goals (1.2) — most critical:

  • 3–5 goals present (3 is ideal; more than 5 is a red flag)
  • Every goal uses a Q42 property tag
  • Every goal has a concrete, measurable scenario with specific numbers — if not, ask the user for the metric now
  • Goals are ordered by priority
  • Sign-off responsibility is named → if missing, ask who will approve them

Requirements overview (1.1):

  • Stays within 1 page (LEAN) or 2 pages (ESSENTIAL/THOROUGH)
  • Business value is explained, not just features listed
  • Focuses on THIS system only — no other systems described
  • References to existing requirement docs are included if they exist

Stakeholders (1.3):

  • All relevant parties are listed — prompt the user if obvious roles are missing (e.g. no ops/DevOps listed for a deployed system)
  • Each stakeholder has a stated expectation, not just a name

Cross-section consistency (if other sections exist):

  • Quality goals align with any decisions already documented in Section 9
  • Stakeholders are consistent with communication partners in Section 3

Then ask: "What would you like to refine or expand?" and iterate until the user is satisfied.


Based on docs.arc42.org/section-1

Comments

Markdown supported