These are all valid points and are generally good to follow. However, one should also look down at how much time has been alotted to documenting your product. In my experience, I was never able to apply all of the above mentioned points completely due to time constraints imposed by various factors (management being one of them ;). Although, documentation is a very important piece, in practice there's not always enough time to finish it off.

Thus, a few suggestions as to how you might save time all the while produce sufficient documentation.

• Write your documentation as you move through your project. Project managers sometimes overlook the need for allowing extra time to add documentation to a working code. Most often, they are reluctant to do so when you are all done and the product seems to work just fine (especially in the Web environment, the project is simply closed with too little documentation). However, if you were to ask for a little bit more time during the coding phase (write it off on various factors if you don't really want to disclose the detailed facts), they'll normally give in and thereby provide you with ample room to fit adequate documentation.
  
  
• Write your documentation to look perfect (as much as you possible can) the first time. I know, I know! It is not always possible and I'm nuts for suggesting it, but what I'm saying is at least make it a 'point' to drive at. This will reduce the time you'll have to spend to hack at poorly written/organized documentation.
  
  
• This leads to the next point... Organize your documentation, always! ;). A good documentation outline will normally lead to a well written documentation with minimal time spent writing it.

_____________________

# Under Construction
[download]

---

---

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! —

• How do I compose an effective node title?
• How do I post a question effectively?
• Markup in the Monastery

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:
	&		&
	<		&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.