Project Decumentation
Hi
I am working on a c++ final project . Everything went well but
I could not do the documentation part which includes :
1.Functional specification
2.Technical specification
3.Project plan: project resources, tasks and schedule
4.Design documents: class diagrams etc.
5.User guide
6.Project end report
If you have done this kind of stuff before or if you know it
from you readings , please let me know.
Thank you
I am working on a c++ final project . Everything went well but
I could not do the documentation part which includes :
1.Functional specification
2.Technical specification
3.Project plan: project resources, tasks and schedule
4.Design documents: class diagrams etc.
5.User guide
6.Project end report
If you have done this kind of stuff before or if you know it
from you readings , please let me know.
Thank you
I have not done any of these but I have seen a couple of such docs. Donno what ur tutor might be expecting....
1, Functional Specification:- As the name suggests here u will have to explain the functionality of different parts of ur project. U can say it is like describing to a non-technical user what all things ur program will do.
2. Technical specs:- Explain in technical terms using function names etc about ur program.
3. Project plan: project resources, tasks and schedule :- This doesn't require much explanation I suppose. Timelines etc while developing ur project.
4. Design docs:- I suppose this needs to be done using UML. And hence I wud suggest using a sofware like Microsoft Visio or IBM Rational Rose. There are nine such diagrams. Class diagram, object diagram, Interaction diagram(collaboration and sequence diagrams), component diagram, deployment diagram, State chart diagram, Activity diagram and use case diagram. Use case diagram being the easiest must be there. U can even include a class diagram. U can take one of ur functionality or use case(most relevant use case) and attempt to draw a collaboration or sequence diagram. Object diagram may not be needed since it is similar to Class diagram from object's perspective. Clas and Obj dia shows static behaviour and Interaction hows dynamic.
5. User guide:- How to use ur program from user's perspective explaining the UI etc.
6. Project end report:- Not sure about this. Must be the final big report containing everything about ur project . U know the one with Acknowledgment, conclusion etc etc
These are just what I know and feel. I give no guarantees :D
1, Functional Specification:- As the name suggests here u will have to explain the functionality of different parts of ur project. U can say it is like describing to a non-technical user what all things ur program will do.
2. Technical specs:- Explain in technical terms using function names etc about ur program.
3. Project plan: project resources, tasks and schedule :- This doesn't require much explanation I suppose. Timelines etc while developing ur project.
4. Design docs:- I suppose this needs to be done using UML. And hence I wud suggest using a sofware like Microsoft Visio or IBM Rational Rose. There are nine such diagrams. Class diagram, object diagram, Interaction diagram(collaboration and sequence diagrams), component diagram, deployment diagram, State chart diagram, Activity diagram and use case diagram. Use case diagram being the easiest must be there. U can even include a class diagram. U can take one of ur functionality or use case(most relevant use case) and attempt to draw a collaboration or sequence diagram. Object diagram may not be needed since it is similar to Class diagram from object's perspective. Clas and Obj dia shows static behaviour and Interaction hows dynamic.
5. User guide:- How to use ur program from user's perspective explaining the UI etc.
6. Project end report:- Not sure about this. Must be the final big report containing everything about ur project . U know the one with Acknowledgment, conclusion etc etc
These are just what I know and feel. I give no guarantees :D
Last edited on
Topic archived. No new replies allowed.