Jump to content

Best Practices for Documenting Actor Framework Programming


Recommended Posts

I've been working with the Actor Framework for a little while now, and have been watching some of the CLA Summit videos (thanks for those btw!) and I'm wondering what is the best practice for documenting the architecture of a system built with the Actor Framework.  In one of the videos AQ mentions that UML doesn't have a representation for this.  The class hierarchy gives a small glimpse into what is going on, but doesn't describe how the actors are interacting and the messages that are being passed between them.  I gave the Symbio tool a quick glance and it didn't immediately seem to provide the outline I was looking for.  I want to be able to generate a diagram quickly and easily that describes the architecture so I can hand it to someone and say this is how things work.  I can create something by hand that is UMLish but I'm wanting to ask all of you guys to see what your approaches have been.

Link to comment

Both of those look good to me.  From your response I take it that there is no consensus yet though.  If I were to go and make a one-off diagram, it would likely look something like what you made in your example, but if there is a 'right' way to go about doing this I'd like to conform to a standard.  If one doesn't exist, it should.

Link to comment

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.