I posted this on the Fusebox forums but haven't had much response so I thought I'd try here as well.
I have inherited a FB4.1/MVC app. It's not the greatest code - it uses CFCs but not in a very smart or OO way, and there were repeated unnecessary instantiations all over the place, for example - but it does seem to *mostly* follow the conventions (I haven't really found anything called from the wrong place, for example). I've made some significant modifications and enhancements (and many, many bug fixes) to the app, and eventually maintenance will be handed over to someone else. I'm a Fusebox fangirl but it's been a crash course in MVC for me, and I don't like it any more than I did when I started for an app of this size but we'll leave that can of worms for another day. Anyway, the important part of the statement above is that "maintenance will be handed over to someone else". To keep the app from wandering off the straight and narrow again and to help the poor developer who inherits it, I'd like to supply some documentation on how the system flows - the flow of fuseactions for each particular function and feature - as some of the business logic is kind of complicated. Particularly as the code it's built on is not the greatest - there are certain things that need to be explained as they were not done in the most optimal way to start with. However, I'm not really sure how to go about it. Is there a documention style that's suited to the MVC pattern that I could look at? How do you show what's actually happening at each level? Please note I'm looking not for a recommendation for a tool - I have Visio and Mind Manager and all that and am happy with them - I'm after a method or approach or style. Preferably with (lots of examples). Oh, and needless to say, when I inherited the app there wasn't a fusedoc in sight. I don't relish the thought of retrofitting them, and doubt the client will pay for that anyway. Thanks for any pointers! -- Kay Smoljak http://kay.smoljak.com/ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| Message: http://www.houseoffusion.com/lists.cfm/link=i:4:235840 Archives: http://www.houseoffusion.com/cf_lists/threads.cfm/4 Subscription: http://www.houseoffusion.com/lists.cfm/link=s:4 Unsubscribe: http://www.houseoffusion.com/cf_lists/unsubscribe.cfm?user=11502.10531.4 Donations & Support: http://www.houseoffusion.com/tiny.cfm/54
