Agile documentation with Confluence and Sparx Enterprise Architect

Agile architecture documentation using Conﬂuence and Sparx Enterprise Architect Per Spilling, Objectware JavaZone 2009

Agenda • Why mashup of wiki & UML tool • How • Tips for architecture documentation in Conﬂuence

Typical problems with traditional documentation

Doc 1.0 App 1.0 App 2.0

Foo Bar Foo Bar

Better way UML wiki tool UML model Documentation Repository Repository

The chosen tools UML wiki tool Sparx Enterprise Architect Atlassian Conﬂuence

Exporting from EA

hmm... EARoot/EA1/EA11.png

The solution: Generate diagrams via the EA API

Running the eatools program

The names of the generated ﬁles correspond with the model model/domain_model/domain_model.png

The result: “Live” UML diagrams in wiki

Conﬂuence tips & tricks

Examples of useful plugins • Reporting Plugin • Navigation Plugin • Linking Plugin • ImageMap Plugin • Copy Space • Jira Plugin • Label Tools • Graphviz Plugin • Metadata Plugin 2 • Chart plugin

Copy space plugin

Versioning

Dynamic table of contents

.. do this Update the page layout (Conﬂuence admin). See recipe: http://conﬂuence.atlassian.com/display/DOC/Adding+a+Navigation+Sidebar

Conﬂuence page templates

Dictionary term template

Dictionary term template Navigation Plugin

Dictionary term template Metadata Plugin 2

Dictionary term template Label Tools plugin

Using the template

Creating reports using metadata Metadata Plugin 2: {metadata-report}

Add-page “buttons” Linking Plugin Specify which template to use

Use labels to specify relationships

depends_on_bird-app-003

Project reports with Chart & Metadata Plugin

{chart:type=bar|width=500|height=200|orientation=horizontal} || || Tasks || || Ikke påbegynt | {metadata-matches:Status|root=@parent| pages=@descendents|label=pcom_oppgave}Ikke påbegynt{metadata- matches} | || Påbegynt | {metadata-matches:Status|root=@parent| pages=@descendents|label=pcom_oppgave}Påbegynt{metadata-matches} | || Ferdig | {metadata-matches:Status|root=@parent| pages=@descendents|label=pcom_oppgave}Ferdig{metadata-matches} | {chart}

Graphviz plugin - ex: {spacegraph}

Thank you Java program for generating diagrams will be made available for downloading after the conference

Agile documentation with Confluence and Sparx Enterprise Architect

by Per Spilling on Sep 12, 2010

Accessibility

Categories

Tags

Upload Details

Usage Rights

Statistics

Agile documentation with Confluence and Sparx Enterprise Architect — Presentation Transcript