I want to do [documentation] so that project can be maintained better. Especially so that, I can understand it easily from the document instead of looking at code, whenever need arises to modify.

You're falling victim to a common fantasy: that maintenance programmers will read great works of documentation before they set about making changes. In 20+ years in the business, I have rarely seen this happen. Instead, the best you can hope for is the equivalent of a quick glance at a map before hopping into the car, with occassional checking of the map along the way.

So go graphical, and give people something they can assimilate quickly. I like UML sequence diagrams for giving me a quick understanding of flow, and some form of class diagram to give me some idea how things are constructed. An occassional State chart is also an effective way of communicating what your program is doing.

Martin Fowler's UML Distilled is a excellent (and short) introduction to UML.

In reply to Re: Algorithm, Flowchart and Refactoring by dws
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.