Documenting MVCS and Project.

Diego Ortega's Avatar

Diego Ortega

16 Jan, 2012 03:03 PM

I am continuing a project developed in FLEX/ZEND/PG with RobotLegs, i want to know if you can recommend me some tools for documenting this project, if these are Open Source, Better.

Thanks.

  1. Support Staff 1 Posted by Till Schneidere... on 16 Jan, 2012 04:02 PM

    Till Schneidereit's Avatar

    Hi Dortega,

    can you give some more information about what kind of documentation
    you want to create? Depending on that, there's a lot of different
    tools you could use.

  2. 2 Posted by Diego Ortega on 16 Jan, 2012 05:11 PM

    Diego Ortega's Avatar

    Hi, thanks for the quick reply.

    The arquitecture, events, classes, database, user manual, everything involved.

    From Views to Database.

    D. O.

  3. Support Staff 3 Posted by Till Schneidere... on 16 Jan, 2012 06:09 PM

    Till Schneidereit's Avatar

    Hi Dortega,

    that's a very wide-ranging question, then. In my experience, a
    combination of using tools like AsDoc to create basic API docs
    automatically, then a diagramming tool such as OmniGraffle, Visio or
    Gliffy for flow diagrams and, most importantly, a hand-written
    documentation of the most important activities occurring in the entire
    application is a good mix.

    There really isn't one good tool for all of these parts, so you have
    to mix and match until you're satisfied.

    On another note: that's really not that much of a Robotlegs-specific
    question, so you'll probably get much better answers in a less
    specific forum such as stackoverflow.com.

    hope that helps,
    till

  4. 4 Posted by Diego Ortega on 16 Jan, 2012 06:12 PM

    Diego Ortega's Avatar

    Thanks Till, i will look into it!

  5. Ondina D.F. closed this discussion on 10 Feb, 2012 11:56 AM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac