Software Projects Documentation

Dear Expert,

Do you know where can I find information about software projects' documentation?

Thanks in advance,
Kambiz
LVL 2
kambizAsked:
Who is Participating?
 
RadlerConnect With a Mentor Commented:
The great benefit of UML is your applicability at a lot of uses.
The pain of studies will be awarded.

T++, Radler.
0
 
mullet_attackCommented:
On the wall in our office, we have a poster that says "Real programmers don't document. If it was hard to write, it should be hard to understand, and even harder to modify"

Seriously, what sort of documentation are you interested in? Depending on the audience, the documentation depth and style will vary greatly, eg doco for Managing Director will be quite different to doco for programmer.

For programmer type doco where you want to document the inner workings of your code, I suggest a buy good book on Object Oriented Programming techniques. Any good book will have chapter(s) on how to design and document your software.

Any help?
0
 
StefaanCommented:
Hi,

If you need some End-User documentation, I would suggest you to buy a help authoring tool.

I've been using Help and Manual for quite some years now, and I think it offers the best value for money I've seen till today.  With this tool you can create Windows Help Files, HTML Help files, Printed Documentation, RFT Files all from the same source.

If you are interested in the product, go and take a look at http://206.245.142.134/index.html

Best regards,

Stefaan
0
Free Tool: ZipGrep

ZipGrep is a utility that can list and search zip (.war, .ear, .jar, etc) archives for text patterns, without the need to extract the archive's contents.

One of a set of tools we're offering as a way to say thank you for being a part of the community.

 
RadlerCommented:
Hi kambiz,

The end users doc's was cited, but my real interest ( and your too I imagine ) is a complete integration between Delphi and UML.( A CASE tool to document and design software ).
UML is a standard industry today, and a theorical aproach inside UML is a great help to development of any software artefact.
If anyone make a comment about you'll can analise.

T++, Radler.
0
 
kambizAuthor Commented:
First of all, I am sorry for my late response.

My intrest is not end user's manual. UML is a good suggestion. However, I do not have time to read more than 700 pages to learn UML. Of course, If it does not have any replacement, I should read it.

Thanks a lot,
Kambiz
0
 
kambizAuthor Commented:
Radler, I agree with you. UML is the best choice.

Kambiz
0
Question has a verified solution.

Are you are experiencing a similar issue? Get a personalized answer when you ask a related question.

Have a better answer? Share it in a comment.

All Courses

From novice to tech pro — start learning today.