Random thoughts...

I always think of my test suite as one of my prime sources of documentation. If you've not already got one, write one. Especially since you can't really refactor with any confidence without one.

Personally, I put a good test suite above any other sort of documentation - so I'd do that first (if not already done).

As for "standard languages" UML is probably your best bet. The various UML diagram types probably cover all that you need. The basic state & class diagrams will probably be enough for you.

However, if you're going to be refactoring your code base it doesn't sound like it's going to be worth documenting structures that you are going to change.

If you're writing documentation for "perl" people - consider using POD. It's a nice simple format, and the fact that its usually in close proximity to the code means that it tends to be updated and accurate.

In reply to Re: Algorithm, Flowchart and Refactoring by adrianh
in thread Algorithm, Flowchart and Refactoring by artist

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.