Sample of project report

Question

hello, i am a student. as a part of our curriculam we need to work as a trainee on a live project and submit the documentation of the project to the college. i am aware of the things like ER diagram and use-case models that i need to include but am not sure the sequence to follow. also is there any different way for software engineering matters like requirement determination and system analysis and design for web applications? am currently working on jsp. it would be nice if anybody could give me a link for some kind of template.. thanks.

Answer 1

but am not
sure the sequence to follow. Different projects have different sequence of steps of development depending on the project's budget, time to completion, size of the project, methods used (eXtreme Programming, Water Fall, Iterative etc).
So the sequence of development differs based on the above (not limited to ) criteria.
I personally would first spend months to gather requirements and file them into Use Cases, build a prototype or some kind of a mock-up based on those requirements.
But business requirements always change, even though they change the Use Cases and screen mock-up sometimes serve as a guideline for developers to understand the modules to be developed, or the history behind a business requirement.
Database ER diagrams should be independent of your applications implementation.
You could decide on a highly normalized database or a de-normalized database. If you want to use a database framework like Hibernate then normalized databases with single primary keys (not composite primary keys) , work well. If you are working with legacy databases then iBatis works well. In either case you could also use JDBC to connect to the database.
So based on the above, you could build an ER diagram first if you want, that way you'd have a database to work with.
Then comes the front-end , middle application layer.
For the front-end you could use screen mock-ups, or modify them and use technologies like JSP/JSTL 1.1 , or JSF 1.2 framework or other MVC frameworks like Struts, Spring, custom etc.
If your application is for the Web, then build your UI UML diagrams according to the MVC pattern for a clean and commonly understood design.
For the middle buiseness layer you could build UML diagrams based on other design patterns.
also is there any
different way for software engineering matters like
requirement determination and system analysis and
design for web applications? am currently working on
jsp. it would be nice if anybody could give me a link
for some kind of template.. thanks.All depends on the goals of your application, and it's size and what software development method you prefer:
Here's a link on XP : http://www.extremeprogramming.org/
Other Agile S/W development methods:
http://en.wikipedia.org/wiki/Agile_software_development
Also if you look under "See Also" , it lists a set of s/w development methods:
http://en.wikipedia.org/wiki/Software_development_process