System Requirements
Write the minimum system requirements of your project, you can have the following requirements listed:
- Operating System required
- Processor
- RAM
- Hard Drive Space
- Any third party drivers or applications (that you cannot distribute with the project), etc.
Development Environment
Use this page to give the information about the development environment that you have used, it basically includes the programming languages, database systems or any other tools that you have used. List the name of programming language/environment and its version, database system and its version and any other tools used.
User Interface
In this part you have to explain the parts or systems of user interface. To put simply, list all the menus, dialog boxes (for windows application) and web pages and their forms (for web application). List them all and give a one or two liner description about them.
Next we have to describe each and every form or web page in detail. It follows a general format (which can be changed according to requirement) which you can use for every other form or web page.
For Windows Application
- Start with the name of the form, then its one liner information below the name.
- Write the summary of the form in 3-4 lines.
- Give information about all the controls in the form in either a tabular form or simply copy-paste the designer code.
- Put the image or screenshot or the form. You can do that by using the ‘Print Screen’ button on your keyboard, it copies the computer screen in image format in the clipboard; you can then paste it in any image processing software, like MS Paint etc.
- Put the code of the form after that.
 |
| List of controls in tabular form |
For Web Application
- Start with the name of the web page and one liner description after that.
- Write the summary in 3-4 lines.
- Put the screenshot of the web page.
- And lastly put the code of the entire web page after that.
 |
| Title and summary of web page |
If you have used any other modules or classes then put them also, by following the same format, examples are any classes or external code files.
Limitations
Here you put the limitations of your project; you can describe what else could have been done and the limitations for that. The limitations can be technical, economical, time dependent etc.
Conclusion
In this part write in brief the basic idea of the project. Try to put in something new here without repeating anything from the above. Try to take things to introduction of the project and giving it a decent ending.
Headers and Footers
Use headers and footers for page numbers, project name, branch name and college name. Arrange them as you like but don’t put too many details in them.