Vous êtes sur la page 1sur 7

Guidelines to prepare B.

Tech project documentation

Font : 1. Chapter Names - 16 TNR (bold) all caps


2. Headings - 14 TNR (bold) all caps
3. Subheadings - 14 TNR (bold) Title case
4. Sub sub headings - 12 TNR (bold) Title case
5. Body of Project - 12 TNR
6. Text in Diagrams - 12 TNR (all lower case)
7. Diagrams / Table headings / Fig. Headings - 12 TNR Title case
8. If any text 12 TNR (Title case)

Spacing : 1. 2 line spacing between heading and body text.


1.5 line spacing in body text.
New paragraphs start with single tab.
Spacing between two paragraphs is to be 1.5 line spacing.

Margins : Left 1.5 Right 1.0


Top 1.0 Bottom 1.0

Page numbers: position Bottom, Middle


1. Front Pages Small Roman Numbers
(Excluding title page, Certificate page, Acknowledgement page)
2. Body pages 1,2,3 .
3. Annexure 1,2,3..
(Separate for each Annexure)

Pages : Size : A4 paper Color: White

Documentation : Spiral Binding

Front Pages Page 1 Title Page


Page 2 Certificate
Page 3 Company Certificate
Page 4 Acknowledgement
Page 5 Contents
Page 6 Abstract
Page 7 List of Figures/ tables/ screens
Page 8 Symbols & Abbreviations
CONTENTS <TN 14 B UC>

Abstract <TN 12 B UC>

List of Figures
List of Tables
List of Screens <TN 12 B UC>

Symbols & Abbreviations

1. INTRODUCTION <TN 12 B UC>

1.1 Motivation
1.2 Problem definition <TN 12 NC>

1.2 Objective of Project


1.3 Limitations of Project
1.4 Organization of Documentation

2. LITERATURE SURVEY
2.1 Introduction
2.2 Existing System
2.3 Disadvantages of Existing system
2.4 Proposed System
2.5 Conclusion

3. ANALYSIS
3.1 Introduction
3.2 Software Requirement Specification
3.2.1 User requirement
3.2.2 Software requirement
3.2.3 Hardware requirement
3.3 Content diagram of Project
3.4 Algorithms ad Flowcharts
3.5 Conclusion

4. DESIGN
4.1 Introduction
4.2 DFD / ER / UML diagram (any other project diagrams)
4.3 Module design and organization
4.4 Conclusion

5. IMPLEMENTATION & RESULTS


5.1 Introduction
5.2 Explanation of Key functions
5.3 Method of Implementation
5.2.1 Forms
5.2.2 Output Screens
5.2.3 Result Analysis
5.4 Conclusion

6. TESTING & VALIDATION


6.1 Introduction
6.2 Design of test cases and scenarios
6.3 Validation
6.4 Conclusion

7. CONCLUSION : First Paragraph - Project Conclusion


Second Paragraph - Future enhancement

REFERENCES: It should contain list of references in the order as they appear in the Thesis.

APPENDICES:

A.

B.

C.

Note: Appendices should provide the required information for understanding and support of the
Thesis.

4. Format to write references:

Author name 1, author name 2, author name 3, Title of the reference, name of the proceedings/Journals
in which it is published, Vol. number, issue no, year and month, page numbers from--- to---.

For example:

[1] Hugh Ruduick and Radrigo Palma, Economically Adapted Transmission System in Open Access
Schemes-Application of Genetic Algorithm, IEEE Trans on Power Systems, Vol. 11, No. 3, Aug 1996,
pp. 1427-1440.

If the referred one is a text book, the following is the format to write the reference.

Author name 1, author name 2 Title of the text book, name of the publisher, year of the

Publication and number of edition.

For example:
[1] Roy Billinton and Ronald N. Allan, Reliability Evaluation of Engineering systems, reprinted in India,
2007, Pergamon Press.

5. How to use references in the text

If there is only one author, the paper must be referred in the following way:
Author name [reference number] has stated and so on.

If two authors are there the paper must be referred in the following way:
Author name 1 and author name 2 [reference number] have stated and so on

If more than two authors are there, the paper must be referred in the following way:
Author name 1 et al. [reference number] have stated and so on.

In a text, the references have to be used as follows:

1. If only one reference is to be used then


Statement [Reference number]

2. If two or more references which can be non- consecutive are to be used, then
Statement [reference number 1, reference number 2]

3. If three or more references which are consecutive have to be used, the


Statement [reference number 1- reference number 3]

6. Punctuation:

Punctuation of the statements is very important whenever a text is to be documented. One can use
interactively for errors in the text, wherein the MS word document facilitates by underlining the
words/sentences with red or green color. Spell check facility and multiple option facility for each word
can also be used for this purpose.

Whenever Therefore or Hence or Similarly or Further are used in the text comma should
be followed.
That is can be abbreviated as i.e.,
For Example can be abbreviated as for e.g.,
Comma or Full-stop have to be used at the end of the word of a sentence whenever required.
When multiple words are used etc. is to be used in the following manner:
Word 1, word 2 etc., (If the sentence is to be continued.)

Word 1, word 2 etc.. (If the sentence is to be completed.)

7. Format to write/cite Equations:

The following format has to be followed for numbering the equations:

Equation (2.1)
The following format has been followed for citing the equations:

Eqn. (2.1) -------- for single equation

Eqns. (2.1), (2.4) and (2.7) -------- for different multi equations

Eqns. (2.1) to (2.5) -------- for subsequent multi equations

Note: For every Chapter, separate numbering should be assign to the equations followed

by its Chapter number.

8. Format to write Figures:

Figure numbers must be mentioned before the actual Figure is drawn, and Caption for the
Figure must be specified, at the bottom of the Figure
For ex. as shown in Fig. 2.1.

Using Figure numbers in the text should be done as follows:


from Fig 2.1, it can be observed or concluded that.

More than one Figure to be stated at once can be written as:


Figs. (2.1) and (2.2) or Figs. (2.1) to (2.3) or Figs. (2.1), (2.4), (2.5) and so on.

9. Format to write Tables:

Table number must be mentioned before the data or results are given.
For ex:

The data of the test shown in Fig. 2.1 is given in Table 2.1.

Caption for the table must precede the content of it.


Whereas for the Figure, the Caption must proceed after it.
Where the tables have to be used in the text, they can be used as follows:
i) If only one table to be used for text, for e.g.,
From Table 2.1 it can be observed that

ii) If more than one table to be referred in the text, for e.g.,
From Tables 2.1 and 2.4 it can be observed that

iii) If more than two and consecutive tables to be used, for e.g.,

From Tables 2.1 to 2.3 it can be observed that

10. Indentation:

Indentation means leaving of space at line beginning, i.e. the leaving of space between the margin
and the beginning of a line or row, or the blank space. It also means aligning the text to a particular
Space.

Paragraph indentation is to be done with one tab setting.


Whenever algorithms are to be written, the text is to be documented in the following way:
Step 1. - - - - - -
Step 2. - - - - - -

| Indentation

Step 11. - - - - - -

Other points:

1. For Chapter, C should be capital letter.

2. Chapter title is to be in bold and CAPITAL LETTERS.

3. For Section, S should be capital letter.

11. Appendices:

Any additional material may be included to support the Thesis in the Appendices.

12. Student Bio-Data:

(It should be last section of project thesis/book)

Name:
Father Name:

Roll. No./Admn. No.:

Date of Birth:

Nationality:

Communication Address:

Town/Village: Mandal: District:

PIN Code:

State:

Ph. No./Mobile.:

e-mail:

Permanent Address:

Town/Village: Mandal: District:

PIN Code:

State:

Ph. No./Mobile.:

e-mail:

Qualifications:

Technical Skills:

Area of Interest:

Declaration:

The above information provided by me is true to the best of my knowledge.

Signature

Vous aimerez peut-être aussi