Dear Monks
I have a task to document my project. The documentation part is not the requirement from the higher-ups. I want to do it 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. Not that looking at the code is hard, but I like to see the things from other persepctives. I also like to show something to the management from other view points so that they can have better idea of the work especially about complicated logic. I also like to refactor it so that the logical flow of the program could be modified and makes it easy for future improvement.

My Project is about text conversion from one format to other format and it is object oriented. It's around 2000 lines of code and grew in organic nature as per requirements came. More requirements and different interfaces (Example GUI) to use the code are yet to come.

My question to the monks are

  • Where I should start and how I should go about the entire process ?
  • Is there a standard language for the flow of logic?
  • Is there a standard language for describing data-processing or data conversion operations?
    and
  • Whatever other lights you can throw in this matter.

    Thanks,
    Artist

    Update: I just read on developer *.
    The Principle of Layout states: Use the visual layout of your code to communicate the structure of your code to human readers.

    That is the line perhaps, I am thinking along.

    In reply to 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.