You are on page 1of 7

Following is a checklist of good documentation points:

• Objective of the program is clearly stated in the beginning.


• Objective of each function is clearly mentioned in the beginning
of each function.
• Comments are inserted at the proper place so as to enhance the
understandability and readability of the program. (Note: Over
commenting doesn’t help)
• Variables and function names are meaningful and appropriate.
• Single letter variable names are not used.
• Program name is meaningful. (Note: It is not proper to use your
name as program name, for example, ‘raman. py’ or ‘namya.py’ to
denote your program code. It is more appropriate to use the
program name as ‘bankingProject.py’ for a banking related
program or ‘admProcess’ for an admission related program.)
• Program code is properly indented.
• Same naming conventions are used throughout the program.
(Note: Some of the naming conventions are firstNum, first_num, to
denote the variable having first number). Let’s do this exercise for
our peer’s case studies as well and provide a feedback to them. A
relevant peer feedback helps in improving the documentation of
the projects. It also helps in identifying our mistakes and enriches
us with better ideas used
by others.
This page consists of instructions and is not to be printed .

1. Keep all the documents except DECLARATION(its on page 7) in


the same order as given.

2. Declaration should be placed at the end of the project file.

3. Certificate(printed copy will be provided by me) must be placed


BEFORE the ACKNOWLEDGEMENT page.

4. The project code and the output screens should be placed after the

dataframe Detail page.

5. Soft copy(save entire folder including project,Ms world file and py


file) of your project should be saved on CD and
attached on the last page of your project

6. Spiral binding of project hard copy is must

7. Fill in the following details(Before submission):

Fill in the blanks on the certificate page


Name and board boardrollno on the acknowledgement page
Signature,board rollno ,Name,Date on the declaration form

SUBMIT PROJECT ON TIME(hard copy and soft copy)

Any queries ,clear them before the submission date.

Madhurima Kashyap
Order of project and take care of formatting before printing
Page 1
Cover page will include
Name of the project

Name of all the students(Students name,class section)

Page 2
Certificate(Take the printout of certificate sent by me)

PAGE 3
ACKNOWLEDGEMENT

I hereby thank the school and the staff of the computer department for
all the guidance and support extended to me during the course of this
project.

My special thanks are due to the Principal for providing us with a right
platform and environment to complete the project.

My sincere thanks to Ms. Madhurima Kashyap our Informatics Practices


teacher for her able guidance , unflinching support and the affectionate
touch without which this project would not have been a success.

Finally I thank all those who have directly or indirectly contributed to the
success of this project.

Name :

Roll No :
PAGE 4

HARDWARE REQUIREMENT :

SOFTWARE REQUIREMENT :
PAGE 5

Write the brief outline about the python Pandas and


Plots,datframe,csv(as per your project)

PAGE 6

SYNOPSIS OF THE PROJECT

Introduction to the project.

A brief outline of what the project is about.

PAGE7
AIMS AND OBJECTIVES

* To restrict unauthorised access of the project and important data.

* To increase the security and safety of data as every manager has its
own login area.

* To get validated data through constraints implemented on oracle


tables.

* To maintain different accounts of manager.

* To maintain different items data like item code,item name,opening


quantity,quantity purchased etc..

* To maintain different suppliers data like supplier code,company


name,city etc..

* To search a specific item.

* To generate necessary reports like item detail,sale items and


purchase items.
PAGE 7
Advantages of the project

Page 8
Dataframes used in the Project with data

Page 9 t0……..n

Coding screens all the screens will be printed at runtime with relevant
data.
Last page
DECLARATION

I, Roll No . a student of DPS , Navi

mumbai humbly submit that I have completed the project work as

described in this report by my own skill and study as per the

instructions of my teacher Ms. Madhurima Kashyap and that I have not

copied the report or its any appreciable parts from any other literature in

contravention of the academic ethics.

DATE : SIGNATURE OF THE STUDENT

You might also like