project writing/documentation fr MFC [modified]
-
Hi , My cousine who is doing final year of mCA asked me about the project writing for MCA course.. Since MFC is OOP and difficult to document I guess. She wanted in the following format.
Requirement Analysis -feasibility Technical Behavior Economical -Design - First level data flow diagram - Second Level data flow diagram - Flow chars. - ER diagram - Database design -Normalization - Interface design - Forms - Reports. - On line help - Testing -Test cases - Error log - System requirements - Limitation - Code.
Out of these flow chart and ER diagram seems to a bit messy in MFC since its not procedural. Also should there be given all the class method descriptions or what.. or code explanation. this is an educational project. What do you think. I am not prefessional of MFC but have some idea. Do you have any links for such documentation of any project or tips. pathak -- modified at 9:58 Monday 29th May, 2006 -
Hi , My cousine who is doing final year of mCA asked me about the project writing for MCA course.. Since MFC is OOP and difficult to document I guess. She wanted in the following format.
Requirement Analysis -feasibility Technical Behavior Economical -Design - First level data flow diagram - Second Level data flow diagram - Flow chars. - ER diagram - Database design -Normalization - Interface design - Forms - Reports. - On line help - Testing -Test cases - Error log - System requirements - Limitation - Code.
Out of these flow chart and ER diagram seems to a bit messy in MFC since its not procedural. Also should there be given all the class method descriptions or what.. or code explanation. this is an educational project. What do you think. I am not prefessional of MFC but have some idea. Do you have any links for such documentation of any project or tips. pathak -- modified at 9:58 Monday 29th May, 2006As the project is on MFC there should be class diagrams for each class. You need give some time to draw the ER diagrams for the project. A class diagram includes class name followed by instance members and then the member functions. You can find the class diagrams in progamming in C++ by Balaguruswamy. For OO design patterns go through this page. http://www.eventhelix.com/RealtimeMantra/Object_Oriented/object_design_tips.htm[^] Regards
-
Hi , My cousine who is doing final year of mCA asked me about the project writing for MCA course.. Since MFC is OOP and difficult to document I guess. She wanted in the following format.
Requirement Analysis -feasibility Technical Behavior Economical -Design - First level data flow diagram - Second Level data flow diagram - Flow chars. - ER diagram - Database design -Normalization - Interface design - Forms - Reports. - On line help - Testing -Test cases - Error log - System requirements - Limitation - Code.
Out of these flow chart and ER diagram seems to a bit messy in MFC since its not procedural. Also should there be given all the class method descriptions or what.. or code explanation. this is an educational project. What do you think. I am not prefessional of MFC but have some idea. Do you have any links for such documentation of any project or tips. pathak -- modified at 9:58 Monday 29th May, 2006 -
Hi , My cousine who is doing final year of mCA asked me about the project writing for MCA course.. Since MFC is OOP and difficult to document I guess. She wanted in the following format.
Requirement Analysis -feasibility Technical Behavior Economical -Design - First level data flow diagram - Second Level data flow diagram - Flow chars. - ER diagram - Database design -Normalization - Interface design - Forms - Reports. - On line help - Testing -Test cases - Error log - System requirements - Limitation - Code.
Out of these flow chart and ER diagram seems to a bit messy in MFC since its not procedural. Also should there be given all the class method descriptions or what.. or code explanation. this is an educational project. What do you think. I am not prefessional of MFC but have some idea. Do you have any links for such documentation of any project or tips. pathak -- modified at 9:58 Monday 29th May, 2006Means, I have to write block diagram for each class showing class members, methods. then I should draw some ER diagram or UML showing relations between classes. Also I need to describe methods, I need to explain some special code rsponsible for functioning of the program. pathak
-
Hi , My cousine who is doing final year of mCA asked me about the project writing for MCA course.. Since MFC is OOP and difficult to document I guess. She wanted in the following format.
Requirement Analysis -feasibility Technical Behavior Economical -Design - First level data flow diagram - Second Level data flow diagram - Flow chars. - ER diagram - Database design -Normalization - Interface design - Forms - Reports. - On line help - Testing -Test cases - Error log - System requirements - Limitation - Code.
Out of these flow chart and ER diagram seems to a bit messy in MFC since its not procedural. Also should there be given all the class method descriptions or what.. or code explanation. this is an educational project. What do you think. I am not prefessional of MFC but have some idea. Do you have any links for such documentation of any project or tips. pathak -- modified at 9:58 Monday 29th May, 2006- Test cases is done at the same time as requirements. That is because the test case is the requirement written backwards. ie. Requirement, Clikck Button X, Y must appear. Test case. Click Button X, does Y appear? 2) Why use DFD for an OO project. Use class diagerams, they work better. 3) No one hardly ever does this, and often follow the following: a) Meet customer in pub, go through requirements. b) Design it in head while in pub. c) Go home and put the code together. d) Go through it with the client in the pub. e) Get paid. Or at least some variant. For example, if the client is important, all this is held in nice restaurants etc, but the important thing is that alcohol is consumed. Nunc est bibendu
-
- Test cases is done at the same time as requirements. That is because the test case is the requirement written backwards. ie. Requirement, Clikck Button X, Y must appear. Test case. Click Button X, does Y appear? 2) Why use DFD for an OO project. Use class diagerams, they work better. 3) No one hardly ever does this, and often follow the following: a) Meet customer in pub, go through requirements. b) Design it in head while in pub. c) Go home and put the code together. d) Go through it with the client in the pub. e) Get paid. Or at least some variant. For example, if the client is important, all this is held in nice restaurants etc, but the important thing is that alcohol is consumed. Nunc est bibendu
fat_boy wrote:
No one hardly ever does this, and often follow the following:
Thanks, My cousine already needs it. She is studying MCA final year. She has developed a MFC application but as you know to document it was harder as it was a bit complex application. Ok anyway I will tell her to draw some bocks to the no of classes. Put class methods in them then at the bottom of class block put method descriptions. put some class heirarchy, few UMLs. Put some explanation of critical code used. over all introduction, put some summary. thats it. No one is going to understand project on this explanation anyway. :wtf: anyhow those should fill 100 pages. pathak
-
fat_boy wrote:
No one hardly ever does this, and often follow the following:
Thanks, My cousine already needs it. She is studying MCA final year. She has developed a MFC application but as you know to document it was harder as it was a bit complex application. Ok anyway I will tell her to draw some bocks to the no of classes. Put class methods in them then at the bottom of class block put method descriptions. put some class heirarchy, few UMLs. Put some explanation of critical code used. over all introduction, put some summary. thats it. No one is going to understand project on this explanation anyway. :wtf: anyhow those should fill 100 pages. pathak
pathakr wrote:
My cousine already needs it. She is studying MCA final year.
MCA as in Microsoft Certified Archetect? If so then... 1) Why would anyone get this? Surley they know this is just a money grab to Micro$oft. 2) If she really is working on this should she already know how to do all this documentation. I mean that's a big part of what archetects do. It would be like a building engeneer not being able to write a blueprint. E=mc2 -> BOOM
-
Hi , My cousine who is doing final year of mCA asked me about the project writing for MCA course.. Since MFC is OOP and difficult to document I guess. She wanted in the following format.
Requirement Analysis -feasibility Technical Behavior Economical -Design - First level data flow diagram - Second Level data flow diagram - Flow chars. - ER diagram - Database design -Normalization - Interface design - Forms - Reports. - On line help - Testing -Test cases - Error log - System requirements - Limitation - Code.
Out of these flow chart and ER diagram seems to a bit messy in MFC since its not procedural. Also should there be given all the class method descriptions or what.. or code explanation. this is an educational project. What do you think. I am not prefessional of MFC but have some idea. Do you have any links for such documentation of any project or tips. pathak -- modified at 9:58 Monday 29th May, 2006Hi Pathak, I really appreciate the format which you have given and other guyz suggestions, but it will make your cousin's life easier if he/she also consider following tips: 1. As more and more Projects are failing due to poor problem formulation, thus industry is seriously taking steps to cope with that issue through: a. CSH (Classification of Stakeholders) b. QCoH(Qualitative classes of stakeholders c. defining issues through rich pictures d. using Cogitive Maps (CM) instead of conventional DFD's, ERD,s etc. 2. Do not forget to include a. Operational Fesibility (consider user's of the system) b. Political Feasibility (consider user's and organization as a whole, mainly organization's internal environment) c. Schedualing Feasibility (very very very important, its Time Management) 3. And i agree with other guys that since it is a OO application, then you "should" use class diagrams to define the attributes and methods. and in the end, all i can say is "Wish your cousin all the best". cheeerz "Being a Simplebeing means Human Being"
-
pathakr wrote:
My cousine already needs it. She is studying MCA final year.
MCA as in Microsoft Certified Archetect? If so then... 1) Why would anyone get this? Surley they know this is just a money grab to Micro$oft. 2) If she really is working on this should she already know how to do all this documentation. I mean that's a big part of what archetects do. It would be like a building engeneer not being able to write a blueprint. E=mc2 -> BOOM