Jeff,
I have no idea what you are developing but I have been recently
thinking about this pour moi:

Surely the question is how should it look.
-> readme.txt - simple and sweet
-> install.txt - part 1: how to install without reading this doc, part
2..n: gruesome detail
-> licence.txt - BSD,...
-> index.html -> ./doc/lots/of/local/stuff
                          -> javadoc,
                    -> links to your product portal to drag latest
info, faq, registration, support, etc

Rgds
David

On 10/11/06, Jeff Mutonho <[EMAIL PROTECTED]> wrote:
> Hi
>
> What information should such a document carry?What formats/structure do you
> guys  use to for such a document?
> --
>
>
> Jeff  Mutonho
>
> GoogleTalk : ejbengine
> Skype        : ejbengine
> Registered Linux user number 366042
>  >
>


-- 
David Hislop
[EMAIL PROTECTED]
+27 21 913 6519

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"CTJUG Forum" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at http://groups.google.com/group/CTJUG-Forum
For the ctjug home page see http://www.ctjug.org.za
-~----------~----~----~----~------~----~------~--~---

Reply via email to