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

---

---

• Are you posting in the right place? Check out Where do I post X? to know for sure.
• Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:

  <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>

• Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
• Want more info? How to link or How to display code and escape characters are good places to start.