Greetings fellow monks,

I thought this was more a general programming question than a Perl one. I have been reading this brilliant article on functional program specs. Doing what he says to do there has made my life a heap easier.

BUT.....

I don't know how to write good technical specs.
I have tried writing out what I want my program to do. That does help. I feel as though I am missing something though.

My questions are:
How detailed do your specs have to be?
e.g.(Do you plan every sub?)

How do you start writing them?
Do you get a general outline or do you go over each task as they come up?

I have tried super search for past nodes on this but have come up empty.
Any insights, links or books that would help to start writing good technical specs would be greatly appreciated

-dwiz

In reply to How to write technical specs ? by dwiz

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.