Question:
how can i make documentation for a project.give me a clear idia.?
prasun b
2006-10-06 06:01:05 UTC
documentation of project in c language.
Four answers:
Dr.Mr.Ed
2006-10-06 06:35:15 UTC
If you're interested in how to create good documentation, use a tool like Doxygen: http://www.stack.nl/~dimitri/doxygen/

The examples should help you see how it's done.
rockie
2006-10-06 13:35:56 UTC
hey dude.... the documentation of the project is nothng but the detailed theory of the concept u r workng with.... and this includes many things.. u need to follow the Rules & Regulations provided by the IEEE which are important, while preparing the documentation part...



... and I will giv u the IEEE format of the documentation... try to follow them...

--> The 1st page in the documentation shud consider the details abt the Project Title, names of ur Team Members, Name of the Department and ur college details with Icon.



--> The 2nd page in the documentation is the CERTIFICATE of the college and it shud be attested by the Internal Guide and ur HOD.



--> The 3rd page in the documentation is the CERTIFICATE givn by the Company/Organisation/Industry/ u hav workd for the project, with the genuine authorisation.



--> The 4th page in the documentation is the DECLARATION done by you...



--> ACKNOWLEDGEMENT will be the 5th page in the documentation part.



--> The next page shud hav the Index/Table of Contents of the project. The Index shud be presented in the IEEE format.... which is givn below :-

1. Abstract

2. Company Profile

3. Introduction (Purpose, Scope, Terms, Acronyms&Abbrevations, Overview)

4. Overall Description (Interface Requirements of System,User, Hardware, Software, Communication, Functional)

5. Technical Documentation (Coding Technology )

6. Diagrams

7. System Design

8. Screens

9. Testing

10. Bibilography



datz it...!!!

gud luck....!!!
Giridhar R
2006-10-06 13:24:42 UTC
The business objective has to be crystal clear when doing documentation for any program. Next the focus on what is expected to be achieved by the programs. Then the functional specification of the requirement. Then the technical specifications. The first three have to be vetted out by the person for whom the program is being written. So the next time a person looks at the document (assuming he knows programming) it should look like a movie running infron of his eyes.
Ashish
2006-10-06 13:11:38 UTC
If you have any software engineering book ... go through it and you can find there all the ways to make the project documentation..

SDLC is clearly mentioned in these books ...

hope u find one for you...

enjoy working !!!


This content was originally posted on Y! Answers, a Q&A website that shut down in 2021.
Loading...