Scribd
Upload
3 views

Project Documentation Formatting Rules

The document outlines a standardized format for project documentation, specifying font, spacing, margins, and structure. It includes detailed instructions on the content and organization of the document, such as required sections like the title page, executive summary, and chapters on introduction, analysis, implementation, testing, and conclusions. Additionally, it emphasizes the importance of consistency, spell-checking, and proper referencing throughout the report.

Uploaded by

Aseem Bhube
Copyright
© © All Rights Reserved
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
3 views

Project Documentation Formatting Rules

The document outlines a standardized format for project documentation, specifying font, spacing, margins, and structure. It includes detailed instructions on the content and organization of the document, such as required sections like the title page, executive summary, and chapters on introduction, analysis, implementation, testing, and conclusions. Additionally, it emphasizes the importance of consistency, spell-checking, and proper referencing throughout the report.

Uploaded by

Aseem Bhube
Copyright
© © All Rights Reserved
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 4

PROJECT DOCUMENTATION FORMAT

General Instructions

1. The document should be in ARIAL font 12


2. The document should have a standard line spacing of 1.5 throughout.
3. Use Executive Bond sheets for the entire document
4. The total number of pages should be not less than 60 and not more
than 120. Do not fill up pages with unnecessary theoretical data.
5. Margins should be 3 cm on all the sides except left margin which should
be 3.5 cm.
6. Any heading should be of font 16 and subheadings should be of font 14
7. Heading should be underlined and bold. Subheadings should be bold
and need not be underlined.
8. The report should be organised in Chapters.
9. Give page numbers as centre aligned at the bottom of the page.
10. Mention page numbers in the Table of Contents.
11. Do a spell check and ensure there are no grammatical errors.
12. The document should be justified.
13. The formatting of the entire document should be consistent across the
document.
14. All tables and figures should be numbered. Table and figure headings
and title should be given below the respective table and figure.
15. List of tables and List of Figures should be there after the Table of
Contents
16. List of Abbreviations to be given before the beginning of the main
contents.
17. An Executive summary of about 4-5 pages to be written before starting
Chapter 1.
Contents of the Document

1. The first page - Title page

2. Second page - Certificate of Approval of project from the institute

3. Certificate from the company on the company letter head, bearing the

signature of the project guide and project manager

4. Acknowledgement

5. Table of Contents

6. List of Tables

7. List of Figures

8. Executive Summary

9. Body of the Document

i) Chapter 1 - Introduction

ii) Chapter 2 – Background and Related Work

iii) Chapter 3 - Analysis and Design

iv) Chapter 4 – Implementation

v) Chapter 5 - Testing

vi) Chapter 6 – Conclusion, Enhancements and Future

Work

10. Appendices (if required)

11. Bibliography

Please note that this is a generic chapter scheme for the Black book. This

can change based on specific projects such as Testing Projects, Review

Projects. Please get in touch with your internal guides for the chapter

scheme.
Body of the document

1. Introduction

Set the scene and problem statement/specification. Provide the


motivation for this report. Explain the difficulties of the existing system
and the need for the project. Introduce the structure of report (what you
will cover in which chapters).

2. Background

What the reader needs to know in order to understand the rest of the
report. Examiners would like to know that you have done some
background research and that you know what else has been done in the
field. Try to include some references and related work

3. Analysis and Design


o Requirements specifications
o Algorithms and data structures as applicable
o Overall system structure
o Data flow, entity relation, and object diagrams as appropriate

4. Implementation
Discuss the implementation of the various modules. Do not write the
code. Only give pseudo-code, if necessary. Show screen shots. Explain
in simple words the functionality of the modules.

5. Testing

Explain Test plans and how the program/system was verified. Put the
actual test results in the Appendix if possible.

6. Conclusions, Enhancements and Further Work

Explain what you achieved in the project. Give a critical evaluation of


your own work - how could the work be taken further (perhaps by another
student next year)? If you have had problems outside your control that
have affected the progress of your work - for example in obtaining
necessary hardware - it is appropriate to mention them here.

Appendices

 User manual

This should give enough information for someone to use what you have
designed and implemented.
 Test results

Bibliography

Give publication details for all the references you have made in the report.

You might also like