Agile documentation with Confluence and Sparx Enterprise Architect

  • 10,093 views
Uploaded on

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

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

More in: Technology
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
  • Hi Per, I might be very daft, but is there a transcript of the slides somewhere?
    Are you sure you want to
    Your message goes here
  • @pspilling
    I tried to execute steps given at link https://github.com/perspilling/eatools

    but got error below:
    C:\Program Files (x86)\Sparx Systems\EA\Java API> mvn install:install-file -DgroupId=org.sparx -DartifactId=eaapi -Dversion=1.0.0 -Dpackaging=jar -Dfile=eaapi.jar
    [INFO] Scanning for projects...
    [INFO] Searching repository for plugin with prefix: 'install'.
    [INFO] org.apache.maven.plugins: checking for updates from central
    [WARNING] repository metadata for: 'org.apache.maven.plugins' could not be retrieved from repository: central due to an error: Error transferring file: Connection timed out: connect
    [INFO] Repository 'central' will be blacklisted
    Downloading: http://repo1.maven.org/maven2/org/apache/maven/plugins/maven-install-plugin/2.2/maven-install-plugin-2.2.pom
    [WARNING] Unable to get resource 'org.apache.maven.plugins:maven-install-plugin:
    pom:2.2' from repository central (http://repo1.maven.org/maven2): Error transfer
    ring file: Connection timed out: connect
    [INFO] ------------------------------------------------------------------------
    [ERROR] BUILD ERROR
    [INFO] ------------------------------------------------------------------------
    [INFO] Error building POM (may not be this project's POM).
    Project ID: org.apache.maven.plugins:maven-install-plugin

    Reason: POM 'org.apache.maven.plugins:maven-install-plugin' not found in repository: Unable to download the artifact from any repository
    org.apache.maven.plugins:maven-install-plugin:pom:2.2

    from the specified remote repositories:
    central (http://repo1.maven.org/maven2)
    for project org.apache.maven.plugins:maven-install-plugin
    [INFO] ------------------------------------------------------------------------
    [INFO] For more information, run Maven with the -e switch
    [INFO] ------------------------------------------------------------------------
    [INFO] Total time: 42 seconds
    [INFO] Finished at: Thu Aug 22 16:12:45 BST 2013
    [INFO] Final Memory: 1M/4M
    [INFO] ------------------------------------------------------------------------

    Could you please help me out in resolving the same.
    Are you sure you want to
    Your message goes here
  • I responded earlier to Kevin regarding this by email, but the eatools software is now available on GitHub: https://github.com/perspilling/eatools
    Are you sure you want to
    Your message goes here
  • I would like to have the eatools download you mention in your presentation. What do I need to do to get it?

    Thanks
    -Kevin
    Are you sure you want to
    Your message goes here
No Downloads

Views

Total Views
10,093
On Slideshare
0
From Embeds
0
Number of Embeds
1

Actions

Shares
Downloads
172
Comments
4
Likes
9

Embeds 0

No embeds

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
    No notes for slide

Transcript

  • 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
  • 6. Better way UML wiki tool UML model Documentation Repository Repository
  • 7. The chosen tools UML wiki tool Sparx Enterprise Architect Atlassian Confluence
  • 8. Exporting from EA
  • 9. hmm... EARoot/EA1/EA11.png
  • 10. The solution: Generate diagrams via the EA API
  • 11. Running the eatools program
  • 12. The names of the generated files correspond with the model model/domain_model/domain_model.png
  • 13. The result: “Live” UML diagrams in wiki
  • 14. Confluence tips & tricks
  • 15. 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
  • 16. Copy space plugin
  • 17. Versioning
  • 18. Dynamic table of contents
  • 19. .. do this Update the page layout (Confluence admin). See recipe: http://confluence.atlassian.com/display/DOC/Adding+a+Navigation+Sidebar
  • 20. Confluence page templates
  • 21. Dictionary term template
  • 22. Dictionary term template Navigation Plugin
  • 23. Dictionary term template Metadata Plugin 2
  • 24. Dictionary term template Label Tools plugin
  • 25. Using the template
  • 26. Creating reports using metadata Metadata Plugin 2: {metadata-report}
  • 27. Add-page “buttons” Linking Plugin Specify which template to use
  • 28. Use labels to specify relationships
  • 29. depends_on_bird-app-003
  • 30. depends_on_bird-app-003
  • 31. Project reports with Chart & Metadata Plugin
  • 32. {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}
  • 33. Graphviz plugin - ex: {spacegraph}
  • 34. Thank you Java program for generating diagrams will be made available for downloading after the conference