• Share
  • Email
  • Embed
  • Like
  • Save
  • Private Content
Agile documentation with Confluence and Sparx Enterprise Architect
 

Agile documentation with Confluence and Sparx Enterprise Architect

on

  • 10,246 views

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

Statistics

Views

Total Views
10,246
Views on SlideShare
10,245
Embed Views
1

Actions

Likes
7
Downloads
148
Comments
3

1 Embed 1

http://www.docseek.net 1

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel

13 of 3 previous next Post a comment

  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
  • @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
    Processing…
  • 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
    Processing…
  • 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
    Processing…
Post Comment
Edit your comment

    Agile documentation with Confluence and Sparx Enterprise Architect Agile documentation with Confluence and Sparx Enterprise Architect Presentation Transcript

    • Agile architecture documentation using Confluence and Sparx Enterprise Architect Per Spilling, Objectware JavaZone 2009
    • Agenda • Why mashup of wiki & UML tool • How • Tips for architecture documentation in Confluence
    • 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 Confluence
    • 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 files correspond with the model model/domain_model/domain_model.png
    • The result: “Live” UML diagrams in wiki
    • Confluence 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 (Confluence admin). See recipe: http://confluence.atlassian.com/display/DOC/Adding+a+Navigation+Sidebar
    • Confluence 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
    • 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