sepknow
asked on
Software Documentation
Hi experts,
I am looking into the documentation of the software developed.
I need advise in this area new to me. How do I start? Can you point me to
some introductory site?
I am looking into the documentation of the software developed.
I need advise in this area new to me. How do I start? Can you point me to
some introductory site?
SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
The question is not very clear. Each product may have completely different documentation. As a matter of fact, the product I'm currently working on almost has no programmers docunmentation (hmmm, in it has been used for more than 5 years).
If you have some documentation the best start from my point of view is to understand the structure, the architecture of the product. But probably before that you might need to understand what this product doing and how it's working. Next step probably is to understand structure of constituing parts etc. Database structure if DB is used. Any configuration files?
When studying implementation (code) it's good to get familiar to naming conventions, coding conventions etc. Anf finally - may be class implementation etc.
Of course this is very generic approach...
If you have some documentation the best start from my point of view is to understand the structure, the architecture of the product. But probably before that you might need to understand what this product doing and how it's working. Next step probably is to understand structure of constituing parts etc. Database structure if DB is used. Any configuration files?
When studying implementation (code) it's good to get familiar to naming conventions, coding conventions etc. Anf finally - may be class implementation etc.
Of course this is very generic approach...
ASKER
Hi anarki_jimbel,
There is no documentation of any sort so far.
I need to start with something. Your suggestion sounds good.
Is there any convention I can follow?
There is no documentation of any sort so far.
I need to start with something. Your suggestion sounds good.
Is there any convention I can follow?
SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
ASKER CERTIFIED SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
SOLUTION
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
ASKER
Thanks.
Part of the software is written in Borland Delphi Object Pascal.