|
|
Re: Software Documentation
|
Posted: Jun 25, 2004 4:17 AM
|
|
Hi
I think there are two types software documentation.
1. internal documentation
2. external documentation
inter documentation involves source file headers, class headers, function header etc. in short code comments. you can have a good coding standards defined of your own to this thing. u will also find few on the web(search with coding standards).
external documentation involves system manual, user manual(help), installation manual, api docs (if u r dealing with java). again good templates for this is available on web.
other then this there other document exists with software development like SRS (System Requirement Specificaitons), SDS (System Design Specifications), Test Cases etc. good templates for this are also available on web.
ya that's it.
i hope this will make some sense.
Ashish
|
|
Previous Topic
