Solved

Software Projects Documentation

Posted on 2000-04-17
6
217 Views
Last Modified: 2010-04-04
Dear Expert,

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

Thanks in advance,
Kambiz
0
Comment
Question by:kambiz
6 Comments
 
LVL 2

Expert Comment

by:mullet_attack
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?
0
 
LVL 3

Expert Comment

by:Stefaan
ID: 2725614
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
 
LVL 4

Expert Comment

by:Radler
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.
0
Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

 
LVL 2

Author Comment

by:kambiz
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,
Kambiz
0
 
LVL 4

Accepted Solution

by:
Radler earned 50 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.
0
 
LVL 2

Author Comment

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

Kambiz
0

Featured Post

Is Your Active Directory as Secure as You Think?

More than 75% of all records are compromised because of the loss or theft of a privileged credential. Experts have been exploring Active Directory infrastructure to identify key threats and establish best practices for keeping data safe. Attend this month’s webinar to learn more.

Question has a verified solution.

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

Suggested Solutions

Title # Comments Views Activity
FMX enumerated colours 2 84
Intraweb download file link ? 1 108
Magic Software info 18 125
JAudiorecorder record freezing the app 29 59
Objective: - This article will help user in how to convert their numeric value become words. How to use 1. You can copy this code in your Unit as function 2. than you can perform your function by type this code The Code   (CODE) The Im…
Creating an auto free TStringList The TStringList is a basic and frequently used object in Delphi. On many occasions, you may want to create a temporary list, process some items in the list and be done with the list. In such cases, you have to…
Along with being a a promotional video for my three-day Annielytics Dashboard Seminor, this Micro Tutorial is an intro to Google Analytics API data.
Windows 10 is mostly good. However the one thing that annoys me is how many clicks you have to do to dial a VPN connection. You have to go to settings from the start menu, (2 clicks), Network and Internet (1 click), Click VPN (another click) then fi…

911 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

Need Help in Real-Time?

Connect with top rated Experts

23 Experts available now in Live!

Get 1:1 Help Now