agentleFS
dithiothreitoldithiothreitol/ea-skills/skills/ea-model/SKILL.md

ea-model

Skill3 starsChanged 3 months agoMITView on GitHub

Author or extend the ArchiMate model in this repository's YAML DSL. Use when adding elements, relationships or views to an EA model repo, when modelling a business/application/technology landscape from notes or interviews, or when asked to "model", "add to the architecture model", or "put this in ArchiMate". Enforces evidence-backed modelling and defers all semantic judgement to the validator.

We split this skill into the rules it gives an agent

9 rules. About 0 are common, 4 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈4

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    1. Nothing enters the model without evidence: When a fact register exists (facts/register/), cite facts -- the validator resolves the fact …

    line 18
  2. Distinctive:

    Every one of them passed the gate, because inventing a *plausible* element breaks no rule — which is exactly why the discipline has to be …

    line 101
  3. Distinctive:

    One element per thing the sources name: Not one per ArchiMate concept you could justify.

    line 104
  4. Very specific:

    If you genuinely need it to express something, it is assumed: true with a rationale saying what would confirm it.

    line 112
  5. Very specific:

    Only record what the sources actually support.

    line 136
  6. Very specific:

    Do not model deployment as Node --Assignment--> ApplicationComponent.

    line 153
  7. Very specific:

    Never write x/y coordinates.

    line 196
  8. Distinctive:

    If your layer has more elements than the sources have sentences, you are elaborating, not modelling -- and a measured run did exactly that, …

    line 224
  9. Distinctive:

    Do the names survive contest?: Read each name to someone who works there.

    line 228

≈ “Common” is an estimate: at least 1 in 5 of the 308,232 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Authoring the enterprise architecture model

You are adding to a model that is validated by code. Your job is judgement -- which concepts exist, what they are called, what depends on what. The tooling decides whether your ArchiMate is legal. Never argue with the validator; it reads the specification's relationship matrix and you are recalling it.

Non-negotiables

1. Nothing enters the model without evidence. When a fact register exists (facts/register/), cite facts -- the validator resolves the fact and re-verifies its quotes, and the register stays the single evidence base:

provenance:
  - fact: fact-erp-role

Without a register (or for evidence not yet ingested), cite the source directly:

provenance:
  - file: facts/sources/interview-operations-2026-07-15.md
    quote: The ERP core holds the master order records and does the invoicing

or declare an explicit assumption:

assumed: true
rationale: >
  Inferred from the described outage impact; no stakeholder stated this. Confirm at the
  next architecture board.

The quote must be verbatim from the file -- the validator locates it and fails the build if it cannot (PROV003). Do not paraphrase, do not tidy the grammar, do not reconstruct a sentence from memory of the document. Copy it. If the evidence for something is genuinely absent, mark it assumed and say so; that is a legitimate, supported state. Silently inventing a plausible element is the one unrecoverable mistake, because a reader cannot tell it from a real one.

2. Write to model/staging/ unless told otherwise. approved/ is human-signed content; the only path into it is easkills promote (see the ea-approve skill), on explicit human instruction. Staging validates as an overlay on approved: your proposed relationships may reference approved elements, and re-proposing an existing id is an update, not a duplicate -- so model the delta, do not copy approved content into staging.

3. Run the validator before you claim to be finished.

easkills validate --root <repo> --zone staging

Fix errors, re-run. Cap yourself at three repair iterations. If violations survive three passes, stop and report what is unresolved and why -- past that point further attempts stop converging and start hallucinating fixes. Escalate; do not grind.

Where things go

model/<zone>/ holds fragmented YAML, split by layer or segment (business.yaml, application.yaml, relations.yaml, views.yaml). Keep files small enough that a diff is readable. Follow the existing split in the repository you are working in rather than imposing a new one.

Identifiers

Lower-case slugs, stable forever, chosen for meaning: app-erp-core, process-order-fulfilment, cap-order-management. Prefix by kind (app-, cap-, process-, service-, data-, node-, actor-, rel-) because it makes relations files readable. Never renumber, regenerate or "tidy" an existing id -- ids are what make re-runs produce diffs instead of rewrites, and they are referenced from views, governance records and documentation.

Modelling order

Build the capability map first and treat it as the spine — from the capabilities the sources actually describe. It is the most durable and most used artifact in practice, and once applications, processes and data attach to capabilities, portfolio views (redundancy, investment, heat maps) become derivable instead of needing separate modelling. A capability nobody mentioned is not a spine, it is scaffolding.

Then work outward: business actors and processes, application components and services, data objects, technology nodes. Add a relationship only when a source supports it; an unevidenced dependency is a guess, and guesses are what make a model untrustworthy.

Granularity: model what the evidence names, at the grain it names it

This is the measured failure mode of this skill, so it is stated as a rule. A run against a single short interview produced nineteen to twenty-three elements, among them a "Current State" and "Target State" pair from a source that describes no plan. Every one of them passed the gate, because inventing a plausible element breaks no rule — which is exactly why the discipline has to be yours.

  • One element per thing the sources name. Not one per ArchiMate concept you could justify. The layer list above is where to look, not a set of boxes to fill.
  • Do not insert intermediate behaviour to make the picture look complete. If a source says the scheduling system serves dispatch, model SchedPro --Serving--> Dispatch. Adding a "Weekend Run Planning" process between them because ArchiMate has processes replaces a stated fact with a plausible one — and the relationship a reader was looking for is now absent from a model that appears richer.
  • An element whose only justification is completeness does not belong in the model. If you genuinely need it to express something, it is assumed: true with a rationale saying what would confirm it; PROV006 then lists it for a human to accept or drop.
  • Elaboration is not thoroughness. A model twice the size of its evidence is not a better model, it is a less falsifiable one: the reader cannot tell which parts came from the interview and which from a modelling habit.

Element metadata

owner and lastReviewed are mandatory in approved and expected in staging. Unowned content is precisely how EA repositories go stale, so supply a real team or role address, not a placeholder.

For applications, populate portfolio attributes as you go -- they cost nothing now and save re-modelling later:

properties:
  lifecycle: active          # plan | phase-in | active | phase-out | end-of-life
  timeDisposition: Tolerate  # Tolerate | Invest | Migrate | Eliminate
  functionalFit: adequate
  technicalFit: poor
  hosting: on-premise

Only record what the sources actually support. A technicalFit you made up is worse than a missing one.

Security properties (dataClassification, personalData, the sec* ratings, exposure, trustZone) follow the same rule, and ea-security says what each one switches on. A restricted data object or a public portal is worth recording the day a source says so; a rating guessed to fill the field is not.

Relationships

Direction matters and is the most common mistake. ApplicationComponent --Realization--> Capability is legal; the reverse is not. ApplicationService --Serving--> BusinessProcess is legal; BusinessProcess --Realization--> ApplicationComponent is not. When REL001 fires it lists what is permitted between those two types and tells you explicitly if your endpoints are simply swapped -- read the message rather than guessing again.

Do not model deployment as Node --Assignment--> ApplicationComponent; the matrix rejects it. Use serving or realization, or introduce an Artifact.

Composition and aggregation must form a hierarchy. A cycle is an error (REL002), not a style preference.

Motivation layer

Requirements, constraints, principles and goals are first-class elements. What they bind is declared with the appliesTo applicability selector -- element ids, checked by the validator (MOT001 unresolved target, MOT002 selector on a non-motivation element):

elements:
  - id: req-po-retention
    type: Requirement
    name: Retain Purchase Orders for Seven Years
    appliesTo: [data-order-record, app-erp-core]
    provenance:
      - fact: fact-po-retention

appliesTo is for motivation elements binding architecture; a dependency between two architecture elements is a relationship, never a selector. These bindings feed the agent context packs later (AD-09), so scope them honestly: a requirement that binds everything binds nothing.

Views

Views list content; the compiler computes layout.

views:
  - id: capability-realization
    name: Capability Realization
    viewpoint: Capability Map
    documentation: >
      Which application supports which capability. Frames the portfolio-rationalisation
      concern for the CIO.
    include: [cap-order-management, app-erp-core, app-wms]

Never write x/y coordinates. Give each view a documentation line naming the concern it frames and for whom -- a view that exists for no stated conversation is a view nobody reads.

When is this layer done

Two halves, and neither answers on its own.

The mechanical half lists what the layer does not yet record:

easkills readiness --root <repo> --zone staging

Per layer, per checkpoint, naming the elements: capabilities nothing realizes and nothing has assessed, value streams nothing enables, goals and outcomes nothing realizes, processes attached to neither a capability nor a service, components with no lifecycle/timeDisposition (invisible to every portfolio report), services with no consumer, infrastructure that serves nothing, obligations that bind nothing, and layers the fact register covers while the model does not. Nothing there is an error -- an unfinished layer is not a wrong model -- so read it as a worklist, and resist the temptation to close a checkpoint by adding an edge you cannot evidence. A fabricated Realization satisfies readiness and corrupts the model; the report is not worth that.

The judgement half is three questions the tooling cannot ask:

  1. Does the grain match the evidence? One interview supports a handful of elements. If your layer has more elements than the sources have sentences, you are elaborating, not modelling -- and a measured run did exactly that, inventing services and processes nothing stated. Prefer a lopsided layer that the sources support: the lopsidedness is information about where to interview next.
  2. Do the names survive contest? Read each name to someone who works there. If they say "we don't call it that", the name is wrong even when the element is right -- traceability dies at vocabulary, and so does the golden-set score.
  3. Are the gaps recorded rather than painted over? A capability nothing realizes is a finding worth keeping, not a hole to fill with a plausible application. Write the weakness down (properties: {assessment: weak}, or a Gap element) and it stops being an open checkpoint because it is now examined -- which is the honest way to close RDY001, and the only one.

A layer is done when the mechanical list is empty or every remaining item has a recorded reason, and all three questions have answers you would defend in a review. Not when the report is green: --strict is a claim about completeness, and you should only make it once someone has looked.

Reporting back

Say what you added, what evidence backs it, and what you had to assume. List assumptions explicitly as open questions -- they are the agenda for the next review, and burying them in a wall of YAML is how they get accepted by default. Report validator output honestly, including warnings you chose not to fix and why.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.