A presentation showing how one can create high quality agile software architecture documentation by creating a mashup of Confluence and the Sparx Enterprise Architect UML tool. *Update:* The source code for the Sparx EA diagram export tool is now available on github: https://github.com/perspilling/eatools

1. Agile architecture documentation using
Confluence and Sparx Enterprise Architect
Per Spilling, Objectware
JavaZone 2009

2. Agenda
• Why mashup of wiki & UML tool
• How
• Tips for architecture documentation in
Confluence

3. Typical problems with traditional
documentation

4. Doc 1.0
App 1.0 App 2.0

5. Foo Bar Foo Bar

9. Better way
UML
wiki
tool
UML model Documentation
Repository Repository

10. The chosen tools
UML
wiki
tool
Sparx Enterprise Architect Atlassian Confluence

14. Exporting from EA

15. hmm...
EARoot/EA1/EA11.png

16. The solution:
Generate diagrams via the EA API

17. Running the eatools program

18. The names of the generated files
correspond with the model
model/domain_model/domain_model.png

19. The result:
“Live” UML diagrams in wiki

20. Confluence tips & tricks

22. 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

23. Copy space plugin

24. Versioning

25. Dynamic table of contents

26. .. do this
Update the page layout (Confluence admin). See recipe:
http://confluence.atlassian.com/display/DOC/Adding+a+Navigation+Sidebar

27. Confluence page templates

28. Dictionary term template

29. Dictionary term template
Navigation Plugin

30. Dictionary term template
Metadata Plugin 2

31. Dictionary term template
Label Tools plugin

32. Using the template

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

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

35. Use labels to specify relationships

36. depends_on_bird-app-003

37. depends_on_bird-app-003

38. Project reports with
Chart & Metadata Plugin

39. {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}

40. Graphviz plugin - ex: {spacegraph}

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