Want to win a PS4? Go Premium and enter to win our High-Tech Treats giveaway. Enter to Win


Software Projects Documentation

Posted on 2000-04-17
Medium Priority
Last Modified: 2010-04-04
Dear Expert,

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

Thanks in advance,
Question by:kambiz
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions

Expert Comment

ID: 2725426
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?

Expert Comment

ID: 2725614

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

Best regards,


Expert Comment

ID: 2727911
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.
Independent Software Vendors: We Want Your Opinion

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!


Author Comment

ID: 2734338
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,

Accepted Solution

Radler earned 200 total points
ID: 2743925
The great benefit of UML is your applicability at a lot of uses.
The pain of studies will be awarded.

T++, Radler.

Author Comment

ID: 2744323
Radler, I agree with you. UML is the best choice.


Featured Post

Enroll in October's Free Course of the Month

Do you work with and analyze data? Enroll in October's Course of the Month for 7+ hours of SQL training, allowing you to quickly and efficiently store or retrieve data. It's free for Premium Members, Team Accounts, and Qualified Experts!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Have you ever had your Delphi form/application just hanging while waiting for data to load? This is the article to read if you want to learn some things about adding threads for data loading in the background. First, I'll setup a general applica…
In my programming career I have only very rarely run into situations where operator overloading would be of any use in my work.  Normally those situations involved math with either overly large numbers (hundreds of thousands of digits or accuracy re…
In this video, Percona Solutions Engineer Barrett Chambers discusses some of the basic syntax differences between MySQL and MongoDB. To learn more check out our webinar on MongoDB administration for MySQL DBA: https://www.percona.com/resources/we…
In response to a need for security and privacy, and to continue fostering an environment members can turn to for support, solutions, and education, Experts Exchange has created anonymous question capabilities. This new feature is available to our Pr…
Suggested Courses

636 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question