Skip to main content

GUIDELINES TO PREPARE TO PROJECTS DOCUMENTATION

GUIDELINES TO PREPARE TO PROJECTS DOCUMENTATION:-
Font       :               1. Chapter Names            -                16  TimesNewRoman (bold) all caps
                                2. Headings                        -              14 TimesNewRoman (bold) all caps
                                3. Subheadings                 -               14 TimesNewRoman (bold) Title case
                                4. Sub – sub headings    -                 12 TimesNewRoman (bold) Title case
                                5. Body of Project            -               12 TimesNewRoman
                                6. Text in Diagrams         -               12TimesNewRoman (all lower case)
                                7. Diagrams / Table headings / Fig. Headings      -                                                                                                                                          12’ TimesNewRoman Title case
                                8. If any   text                                    12’ TimesNewRoman (Title case)

Spacing                :    1.  2 line spacing between heading and body text.
                                   2.  1.5 line spacing in body text.
                                   3.  New paragraphs start with single tab.

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
Abstract
List of Figures
List of Tables
List of Screens
Symbols & Abbreviations

1.       Introduction                                                                                     
1.1   Motivation
1.2   Problem definition
1.3   Objective of Project
1.4   Limitations of Project
1.5   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       :              
1.       Author Name, Title of Paper/ Book, Publisher’s Name, Year of publication
Full URL Address.

Comments

Post a Comment

Popular posts from this blog

Applications of Insulating Materials

All electrical systems require some kind of insulation to prevent short circuits and leaking currents. 3 forms of insulators: solid, liquid and gaseous Performance of these insulators depend on the temperature Classification according to their temperature rating. Impregnation: Letting the solid material absorb some liquid With the advent of new materials, the classification has been modified by International Electrotechnical Commission: The transformer insulation: (a) conductor or turn-to-turn insulation, (b) coil-to-coil insulation, (c) low voltage coil-to-earth insulation, (d) high voltage coil-to-low voltage coil insulation, and (e) high voltage coil-to-ground insulation. Transformer oil -- provides the required dielectric strength and insulation -- cools the transformer by circulating itself through the core and the coil structure. -- should be in the liquid state over the complete operating range of temperatures between -40°C and+50°C. -- gets o...
15 comments
Read more

JSTL-JSP Standard Tag Library part 2

Evolution of JSTL-JSP Standard Tag Library As JSP grew in popularity, it became clear that different sites' custom tags fell into familiar, frequently used patterns. For example, many pages needed to loop over data to print tables and lists. Vendors of JSP containers and members of the open-source community tried to address these needs by providing collections of tags --tag libraries--that solved common problems. While many JSP page authors used these libraries, nothing tied them together. To address this fragmentation, the Java Community Process --the same group that now maintains and standardizes JSP itself --decided to offer a standard tag library. JSTL 1.0, to include tags for the following common tasks:          •Looping over data to produce tables, lists, etc.          •Conditional operations          •Importing and processing data from other web pages         ...
Post a Comment
Read more

PV/GENSET HYBRID

Introduction: PV and genset systems do not have much in common. It is precisely for this reason that they can be mated to form a hybrid system that goes far in overcoming the drawbacks to each technology. Table 10.1 lists the respective advantages and disadvantages. As the sun is a variable energy source, PV system designs are increased in size (and therefore cost) to allow for a degree of system autonomy. Autonomy is required to allow for provision of reliable power during "worst case" situations, which are usually periods of adverse weather, seasonally low solar insulation values or an unpredicted increased demand for power. The addition of autonomy to the system is accomplished by increasing the size of the PV array and its requisite energy storage system (the battery). When a genset is added, additional battery charging and direct AC load supply capabilities are provided. The need to build in system autonomy is therefore greatly reduced. When energy demands cannot b...
Post a Comment
Read more