EAxWiki

Diagrammen als interactieve documentatie

Diagrammen vormen vaak het belangrijkste communicatiemiddel binnen architectuur.

EAxWiki publiceert diagrammen automatisch als afbeeldingen, gekoppeld aan een eigen documentatiepagina. Gebruikers kunnen diagrammen vergroten, vanuit een diagram direct doorklikken naar gerelateerde elementen en eenvoudig navigeren tussen architectuuronderdelen.

Hiermee verandert een statisch diagram in een interactieve ingang naar de volledige architectuur.

Wijzigingen direct vanuit de browser

Een unieke eigenschap van EAxWiki is de ondersteuning voor live write-back naar Enterprise Architect. Gebruikers kunnen – afhankelijk van de configuratie – rechtstreeks vanuit de wiki onder andere aanpassen:

• status van elementen
• beschrijvingen (notes)
• diagramdocumentatie
• package-documentatie
• beschrijvingen van attributen
• beschrijvingen van methoden
• tagged values

Na het opslaan worden deze wijzigingen direct teruggeschreven naar de Enterprise Architect-repository via de officiële COM-interface. Hierdoor blijft het model altijd de enige bron van waarheid en is dubbel onderhoud niet nodig.

AI als documentatie-assistent

Goede documentatie kost tijd. Daarom ondersteunt EAxWiki AI-gestuurde beschrijvingen.

Met één klik kan een AI-model een eerste voorstel genereren voor de beschrijving van een element. Daarbij wordt rekening gehouden met de context van het model, zodat de gegenereerde tekst aansluit bij de functie van het element en geen informatie herhaalt die al zichtbaar is op de pagina.

EAxWiki ondersteunt OpenAI-compatibele AI-services, waardoor organisaties kunnen kiezen voor zowel cloudoplossingen als lokaal gehoste Large Language Models (LLM’s).

Geschikt voor grote organisaties

EAxWiki is ontworpen voor professionele architectuuromgevingen. Het ondersteunt onder andere:

• Enterprise Architect .qea-repositories
• databasegebaseerde EA-repositories
• geautomatiseerde exports
• monitoring
• logging
• Slack- en Microsoft Teams-notificaties
• publicatie op Windows, Linux en macOS

Hierdoor kan EAxWiki eenvoudig worden opgenomen in bestaande CI/CD-processen of periodieke publicatieomgevingen.

Flexibele architectuur

EAxWiki bestaat uit twee gescheiden onderdelen:

• een exportcomponent die het Enterprise Architect-model omzet naar Markdown;
• een publicatiecomponent die deze Markdown omzet naar een moderne website met MkDocs.

Hierdoor kan de export plaatsvinden op een Windows-machine met Enterprise Architect, terwijl de wiki zonder problemen wordt gepubliceerd op een Linux-server of in een containeromgeving. Deze architectuur maakt EAxWiki flexibel inzetbaar binnen vrijwel iedere IT-infrastructuur.

Meer dan alleen documentatie

EAxWiki is geen traditionele documentatiegenerator. Het platform combineert:

• automatische documentatie
• interactieve navigatie
• modelanalyse
• AI-ondersteuning
• live synchronisatie met Enterprise Architect
• webpublicatie
• monitoring en beheer

Hierdoor wordt een Enterprise Architect-repository niet langer een verzameling modellen, maar een centrale, levende kennisbank voor de hele organisatie.

Hoe onderscheidt EAxWiki zich?

Gebruikers van Sparx Enterprise Architect hebben verschillende mogelijkheden om modelinformatie te publiceren. De keuze hangt af van het doel: documentgeneratie, samenwerking of het ontsluiten van een complete kennisbank.

Enterprise Architect HTML Export / WebEA
De standaard HTML-export van Enterprise Architect is eenvoudig beschikbaar, maar kent beperkingen. De gegenereerde website is statisch, heeft een verouderde gebruikersinterface en biedt beperkte zoek- en navigatiemogelijkheden. Daarnaast ontbreekt ondersteuning voor AI, moderne documentatieplatformen en interactieve bewerking.

EAxWiki zet hetzelfde model om naar een moderne Markdown-gebaseerde wiki die kan worden gepubliceerd met MkDocs. Hierdoor profiteren gebruikers van een snelle zoekfunctie, responsive pagina’s, flexibele thema’s en een eigentijdse gebruikerservaring.

Prolaborate
Prolaborate richt zich op samenwerking rondom een live Enterprise Architect-repository. Gebruikers werken rechtstreeks met het model via dashboards, rapportages en webportalen. Het is daarmee vooral geschikt voor organisaties die interactieve samenwerking, governance en stakeholderparticipatie rondom de repository centraal stellen.

EAxWiki kiest een andere benadering. In plaats van een live modelviewer ontstaat een complete documentatie- en kenniswebsite die eenvoudig kan worden gepubliceerd op een intranet, GitHub Pages of een webserver. Daardoor is de informatie ook beschikbaar voor gebruikers die geen toegang hebben tot de Enterprise Architect-repository.

eaDocX
eaDocX is gespecialiseerd in het genereren van hoogwaardige Microsoft Word-documenten vanuit Enterprise Architect. Het product biedt uitgebreide mogelijkheden voor documentopmaak, Word-sjablonen, reviewprocessen en terugkoppeling van wijzigingen naar het model. Daarmee is het bijzonder geschikt voor organisaties die formele rapporten, ontwerpen of contractuele documentatie moeten opleveren.

EAxWiki heeft een ander doel. In plaats van afzonderlijke documenten publiceert het een volledige online kennisbank waarin alle modelinformatie permanent beschikbaar blijft. Documentatie wordt geen momentopname meer, maar een continu bijgewerkte website.

Waarom kiezen voor EAxWiki?

EAxWiki onderscheidt zich door de combinatie van moderne webtechnologie en directe koppeling met Enterprise Architect. Belangrijke onderscheidende functionaliteiten zijn:

• automatische publicatie naar een moderne wiki;
• incrementele exports voor snelle synchronisatie;
• AI-ondersteuning voor het genereren van elementbeschrijvingen;
• live write-back van wijzigingen naar Enterprise Architect;
• uitgebreide indexen, woordenlijsten en modeloverzichten;
• publicatie via MkDocs met ondersteuning voor moderne thema’s;
• integratie in CI/CD-pipelines voor volledig geautomatiseerde publicatie;
• ondersteuning voor zowel lokale repositories als databasegebaseerde Enterprise Architect-omgevingen.

Hierdoor ontstaat niet alleen documentatie, maar een levende kennisomgeving waarin architectuurinformatie eenvoudig toegankelijk, doorzoekbaar en actueel blijft.

Samenvatting

EAxWiki is daarmee geen vervanger van elk bestaand product, maar een oplossing voor organisaties die hun Enterprise Architect-repository willen transformeren tot een moderne, doorzoekbare en AI-ondersteunde kennisbank. Voor veel organisaties kan EAxWiki bovendien uitstekend naast Prolaborate of eaDocX worden ingezet, waarbij ieder product zijn eigen sterke punten benut.