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

Java Server page tutorial part 3: JSP Life Cycle

JSP Life Cycle: A JSP life cycle can be defined as the entire process from its creation till the destruction which is similar to a servlet life cycle with an additional step which is required to compile a JSP into servlet. Following are the steps followed by a JSP Container: ◦ Compilation  ◦ Parsing the JSP.  ◦ Turning the JSP into a servlet.  ◦ Compiling  the servlet.  ◦ Initialization ◦ Execution ◦ Cleanup Architecture: 1.       JSP Compilation: When a browser asks for a JSP, the JSP engine first checks to see whether it needs to compile the page.  If the page has never been compiled, or if the JSP has been modified since it was last compiled, the JSP engine compiles the page. The compilation process involves three steps: ◦ Parsing the JSP. ◦ Turning the JSP into a servlet.  ◦ Compiling the servlet.  2.       JSP Initialization: When a container loads a JSP it invokes the jspInit() method before servicing any requests.  If you need to perform
Post a Comment
Read more

OPERATION MANUAL FOR RS232 TO RS422/RS485 VICE-VERSA

INTRODUCTION: Milestone model LD-15U is a RS232,  to RS422/RS485 converter is designed for high-speed data transmission between computer system and or peripherals over Iong distance under high noise conditions. They provide dual line interface per signal. APPLICATIONS: Application for these converters can be for factory automation, Programmable logic controllers,, attendance recording systems, Barcode Readers, remote data transmission, remote terminals, EPABX etc. SPECIFICATIONS: Input: RS232-T×D, R×D, DSR (for control), GND (D9 Female connector) Output: RS422/RS485-Tx+, Tx-, Rx+. Rx-(D9 Male Connector). Each signal is protected by spike suppressor, fuse and has opto-isolation. Selection Switch: 1. Rear side has 2-way'SELECT' switch for selecting 2-Wire or 4-Wire mode in RS422/RS485 application. 2. (Optional) Rear side has 3-way'SELECT' switch for selecting AUTO Mode (No Handshake Signal), DSR+ Mode (+12V Control) and DSR-Model (-_12V Control) for co
Post a Comment
Read more

JSTL-JSP Standard Tag Library part 1

Evolution of JSTL: Java is a flexible, general-purpose programming language, JavaServer pages(JSP) depends on java but hides some of the hard details of writing full- fledged programs.  The JSP Standards Tag Library(JSTL) builds on top of JSP, making it even easier to use. Architecture : In this figure large web applications are designed using java, JSTL, and othe components like databases. In large applications, it's common for requests from web browser to be handled by a java program called a servlet, which interacts with databases and other Java code on the server. The servlet figures out how it wants a response be printed and then forwards the user to the right JSTL page, which takes care of nothing more than presenting information. 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 c
Post a Comment
Read more