Hey all,

I'm continuing my most likely life long quest in creating semi-complex and well featured community/message board software and i've come across this quandary: how does one create documenation for their software?

I don't mean just POD, and I don't mean just how, but what is the best method? Obviously you need to tell what key methods do, how to set it up, copyright, etc. but what else does good documentation need? Examples, yes, but how does one keep it easy reading so as to not lose the reader that's not a systems programmer or a computer guru? Not to mention, cover all the bases.

If this seems stupid or already answered, please blame my percoset and it being 4:17 am.

Thanks in advance!!!

meh.

In reply to creating documentation by stonecolddevin

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.