SlideShare a Scribd company logo
1 of 22
Download to read offline
Focused
 Strong
Specific
MAIN SECTIONS OF A DOCUMENTATION



                      Methodologies
                                          Literature
                                          Review
          System
        Analysis
                                         Introductory
                                      & Final Pages

                     Discussion &
        Results
                   Conclusion




                                    Presenting your project made easy
INTRODUCTORY PAGES
Front Page (Main Cover).
 Mansoura University’s logo, Computer and Control Systems
  Department, Project’s Title, Supervisors Name (s), Team Members
  Names, Date (M/Y), Sponsors’ logos, and …
 This phrase: “A Graduation Project Submitted in the partial
  fulfillment of B.S. degree in Computer Science & Information
  Systems.”
 Qur’anic Verse / Quote …




                                             Presenting your project made easy
ABSTRACT
Abstract (Preface) …
 An Abstract shouldn’t exceed about 200 – 500 words in a paper,
  and about 2 pages (Maximum) in a Documentation.
 The English Abstract should be translated at least into “Arabic.”
 Do not cite references in the abstract.




                                                Presenting your project made easy
ACKNOWLEDGMENT & DEDICATIONS
Acknowledgment
 The preferred spelling of the word “acknowledgment” in American
  English is without an “e” after the “g.”
 Use the singular heading even if you have many acknowledgments.
 Avoid expressions such as “One of us (S.B.A.) would like to thank ...
  .” Instead, write “F. A. Author thanks ... .”
Dedications




                                                 Presenting your project made easy
THE REMAINING INTRODUCTORY
PAGES
Table of Contents
List of …
 Figures.
 Tables.
 Equations. (Optional)
 Abbreviations. (Optional)
Document Organization (Structure)
Chapter 1: Introduction                       which usually
  includes sections such as Overview, Motivation, Problem
  Statement, Objective (s), Scope of the work, Solution
  Approaches, Tools Used, … etc.




                                              Presenting your project made easy
CONTENTS OF A LITERATURE REVIEW
Reviewing the different scopes and related domains.
Reviewing main modules in the selected scope.
Reviewing the main approaches and methodologies per module
 State implicitly/briefly the Advantages/Disadvantages as reviewed
  for each approach.
 A simple indirect comparative study may be conducted (in tables
  form).
 At least one chapter in the documentation, but may reach three.
 An example to illustrate all aspects of literature review: Voice
  Recognition




                                                Presenting your project made easy
METHODOLOGIES (PROPOSED SYSTEM)
Detail the researched & implemented methods.
 Determine the scope of the project in more details.
 Use appendices to make a better document structure.

Detail any comparative aspects with other approaches.




                                             Presenting your project made easy
SYSTEM ANALYSIS & DESIGN
Only one chapter.
Block Diagram.
Requirements Specification: System’s Software & Hardware
  Requirements.
Assumptions & Dependencies.
Software lifecycle and time plan.
UML (Unified Modeling Language) Diagrams.
 e.g. Use Case Diagram, Class Diagram, Sequence Diagram,
  Collaboration Diagram, Activity Diagram, State Machine Diagram,
  … etc.




                                              Presenting your project made easy
RESULTS & EXPERIMENTS

Conducted Results.


Comparative Study against other approaches




                                    Presenting your project made easy
DISCUSSION & CONCLUSION
Discuss the achieved results.
Conclude/Summarize the contributions.
 A conclusion section is not required. Although a conclusion may
  review the main points of the paper.
 Do not replicate the abstract as the conclusion.
 A conclusion might elaborate on the importance of the work or
  suggest applications and extensions.
Future Work.




                                               Presenting your project made easy
THE REMAINING FINAL PAGES
References
Appendices
Glossary
Notes




                            Presenting your project made easy
GENERAL GUIDELINES & STANDARDS
Nearly all pages should be numbered (Roman/English numbers).
Not more than a couple of – formal – fonts per page.
Standard indexing & font sizes for paragraphs, sub-titles, sections’
   titles, and chapters’ titles (e.g. 12, 14, 16 and 22).
Don’t write a paragraph consisting of one line.
Usually, in documentations, roman numerals are used only in
   numbering the introductory pages … English numbers are used
   to number the whole document starting the chapters.
Define all symbols and abbreviations before using them (whether in
   text or list of abbreviations).




                                                  Presenting your project made easy
GENERAL GUIDELINES & STANDARDS
Figures, Tables, and Equations should be indexed, and they have to
   be referred to within the text.
Figure explanation should be below the figures; table explanations
   should be above the tables.
Avoid placing figures and tables before their first mention in the text.
Use the abbreviation “Fig. 1,” even at the beginning of a sentence.
Do not change the font sizes or line spacing to compress more text
   into a limited number of pages.
Use italics for ensuring ; do not underline.




                                                  Presenting your project made easy
GENERAL GUIDELINES & STANDARDS
If you are using Word, use either the Microsoft Equation Editor or the
    MathType add-on (http://www.mathtype.com) for equations in
    your paper/document (Insert | Object | Create New | Microsoft
    Equation or MathType Equation).
Use one space after complete sentence and colons.
Avoid dangling participles, such as, “Using (1), the potential was
   calculated.” [It is not clear who or what used (1).] Write instead,
   “The potential was calculated by using (1),” or “Using (1), we
   calculated the potential.”
Use a zero before decimal points: “0.25,” not “.25.”
Indicate sample dimensions as “0.1 cm × 0.2 cm,” not “0.1 × 0.2
   cm2.”




                                                  Presenting your project made easy
GENERAL GUIDELINES & STANDARDS
The abbreviation for “seconds” is “s,” not “sec.”
Do not mix complete spellings and abbreviations of units: use
   “Wb/m2” or “webers per square meter,” not “webers/m2.”
When expressing a range of values, write “7 to 9” or “7-9,” not
  “7~9.”
A parenthetical statement at the end of a sentence is punctuated
   outside of the closing parenthesis (like this). (A parenthetical
   sentence is punctuated within the parentheses)




                                                    Presenting your project made easy
GENERAL GUIDELINES & STANDARDS
Avoid contractions; for example, write “do not” instead of “don’t.”
The serial comma is preferred: “A, B, and C” instead of “A, B and C.”
If you wish, you may write in the first person singular or plural and
    use the active voice (“I observed that ...” or “We observed that ...”
    instead of “It was observed that ...”).
Remember to check spelling.




                                                  Presenting your project made easy
SOME COMMON MISTAKES
The word “data” is plural, not singular.
The subscript for the permeability of vacuum µ0 is zero, not a
   lowercase letter “o.”
Use the word “whereas” instead of “while” (unless you are referring
   to simultaneous events).
Do not use the word “essentially” to mean “approximately” or
   “effectively.”
Do not use the word “issue” as a euphemism for “problem.”




                                                Presenting your project made easy
SOME COMMON MISTAKES
Be aware of the different meanings of the homophones “affect”
   (usually a verb) and “effect” (usually a noun), “complement” and
   “compliment,” “discreet” and “discrete,” “principal” (e.g.,
   “principal investigator”) and “principle” (e.g., “principle of
   measurement”).
Prefixes such as “non,” “sub,” “micro,” “multi,” and “ultra” are not
   independent words; they should be joined to the words they
   modify, usually without a hyphen “nonlinear” “non-linear”
The abbreviation “i.e.,” means “that is,” and the abbreviation “e.g.,”
   means “for example” (these abbreviations are not italicized).




                                                 Presenting your project made easy
Everything that is or was,
    Began with a dream
Thanks
  

More Related Content

What's hot (7)

Plantilla ieee
Plantilla ieeePlantilla ieee
Plantilla ieee
 
Document Design in Technical Writing
Document Design in Technical WritingDocument Design in Technical Writing
Document Design in Technical Writing
 
Technical writing: Some guidelines
Technical writing: Some guidelinesTechnical writing: Some guidelines
Technical writing: Some guidelines
 
Revised 2016 New Rules Powerpoint for Electronic Submission and Essential For...
Revised 2016 New Rules Powerpoint for Electronic Submission and Essential For...Revised 2016 New Rules Powerpoint for Electronic Submission and Essential For...
Revised 2016 New Rules Powerpoint for Electronic Submission and Essential For...
 
How to Write a PhD Dissertation
How to Write a PhD DissertationHow to Write a PhD Dissertation
How to Write a PhD Dissertation
 
Long Reports
Long ReportsLong Reports
Long Reports
 
Trans jour
Trans jourTrans jour
Trans jour
 

Viewers also liked

Instantsearch 110614142640-phpapp02
Instantsearch 110614142640-phpapp02Instantsearch 110614142640-phpapp02
Instantsearch 110614142640-phpapp02Ruben Velasco
 
Kitchen remodelppt
Kitchen remodelpptKitchen remodelppt
Kitchen remodelpptOnapilgrim
 
Bolo chifon de chocolate
Bolo chifon de chocolateBolo chifon de chocolate
Bolo chifon de chocolatecelinesilva
 
Silvertown iSpot at the Crossroads Workshop
Silvertown iSpot at the Crossroads WorkshopSilvertown iSpot at the Crossroads Workshop
Silvertown iSpot at the Crossroads WorkshopJonathan Silvertown
 
Kitchen remodelppt
Kitchen remodelpptKitchen remodelppt
Kitchen remodelpptOnapilgrim
 
Pilgrim mission 1
Pilgrim mission 1Pilgrim mission 1
Pilgrim mission 1Onapilgrim
 
Другу
ДругуДругу
ДругуMr_GisT
 
Alms analysis presentation
Alms analysis presentationAlms analysis presentation
Alms analysis presentationOpenEdBlogger
 
Think how big we are
Think how big we are Think how big we are
Think how big we are usman420
 
ALMS Rubric Open Ed 2012 Presentation
ALMS Rubric Open Ed 2012 PresentationALMS Rubric Open Ed 2012 Presentation
ALMS Rubric Open Ed 2012 PresentationOpenEdBlogger
 
Ocular manifestations of tuberculosis infection
Ocular manifestations of  tuberculosis  infectionOcular manifestations of  tuberculosis  infection
Ocular manifestations of tuberculosis infectionShahid Manzoor
 
Ocular manifestation of hiv
Ocular manifestation of hivOcular manifestation of hiv
Ocular manifestation of hivShahid Manzoor
 

Viewers also liked (15)

10 km 1
10 km 110 km 1
10 km 1
 
Instantsearch 110614142640-phpapp02
Instantsearch 110614142640-phpapp02Instantsearch 110614142640-phpapp02
Instantsearch 110614142640-phpapp02
 
Kitchen remodelppt
Kitchen remodelpptKitchen remodelppt
Kitchen remodelppt
 
Bolo chifon de chocolate
Bolo chifon de chocolateBolo chifon de chocolate
Bolo chifon de chocolate
 
Silvertown iSpot at the Crossroads Workshop
Silvertown iSpot at the Crossroads WorkshopSilvertown iSpot at the Crossroads Workshop
Silvertown iSpot at the Crossroads Workshop
 
Kitchen remodelppt
Kitchen remodelpptKitchen remodelppt
Kitchen remodelppt
 
Maragda,sa
Maragda,saMaragda,sa
Maragda,sa
 
Pilgrim mission 1
Pilgrim mission 1Pilgrim mission 1
Pilgrim mission 1
 
Maragda,sa
Maragda,saMaragda,sa
Maragda,sa
 
Другу
ДругуДругу
Другу
 
Alms analysis presentation
Alms analysis presentationAlms analysis presentation
Alms analysis presentation
 
Think how big we are
Think how big we are Think how big we are
Think how big we are
 
ALMS Rubric Open Ed 2012 Presentation
ALMS Rubric Open Ed 2012 PresentationALMS Rubric Open Ed 2012 Presentation
ALMS Rubric Open Ed 2012 Presentation
 
Ocular manifestations of tuberculosis infection
Ocular manifestations of  tuberculosis  infectionOcular manifestations of  tuberculosis  infection
Ocular manifestations of tuberculosis infection
 
Ocular manifestation of hiv
Ocular manifestation of hivOcular manifestation of hiv
Ocular manifestation of hiv
 

Similar to Documentation

IEEE-Template.docx
IEEE-Template.docxIEEE-Template.docx
IEEE-Template.docxsaran2011
 
How To Write Your Research Dissertation
How To Write Your Research DissertationHow To Write Your Research Dissertation
How To Write Your Research DissertationChris Jobling
 
Report Writing.ppt
Report Writing.pptReport Writing.ppt
Report Writing.pptZenithMBA1
 
Journal article & publishing lecture 2014
Journal article & publishing lecture 2014Journal article & publishing lecture 2014
Journal article & publishing lecture 2014Mohammed Maina
 
Week6-Sectionsofapaper.ppt
Week6-Sectionsofapaper.pptWeek6-Sectionsofapaper.ppt
Week6-Sectionsofapaper.pptKamranAli649587
 
How to Write a Technical Report
How to Write a Technical ReportHow to Write a Technical Report
How to Write a Technical ReportChris Jobling
 
Report Writing Notes.pdf
Report Writing Notes.pdfReport Writing Notes.pdf
Report Writing Notes.pdfZenithMBA1
 
Guidelines for final_year_project_report
Guidelines for final_year_project_reportGuidelines for final_year_project_report
Guidelines for final_year_project_reportJTM
 
2014 environmental engineeringlabmanual
2014 environmental engineeringlabmanual2014 environmental engineeringlabmanual
2014 environmental engineeringlabmanualTAMUK
 
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
ENG101 LECTURE 13 TECHNICAL  REPORT.pptxENG101 LECTURE 13 TECHNICAL  REPORT.pptx
ENG101 LECTURE 13 TECHNICAL REPORT.pptxBismark Budu
 
how to write your project documentation
how to write your project documentationhow to write your project documentation
how to write your project documentationMohannadaljboor
 
a. Collect at least six published papers in one of the new tre.docx
a. Collect at least six published papers in one of the new tre.docxa. Collect at least six published papers in one of the new tre.docx
a. Collect at least six published papers in one of the new tre.docxdaniahendric
 
Writing engineering report
Writing engineering reportWriting engineering report
Writing engineering reportKhaled Eid
 
Report Writing Guide
Report  Writing GuideReport  Writing Guide
Report Writing Guideguest74f577
 
Localization -WritePoint & Net Translators
Localization -WritePoint & Net TranslatorsLocalization -WritePoint & Net Translators
Localization -WritePoint & Net TranslatorsPaula Stern
 

Similar to Documentation (20)

IEEE-Template.docx
IEEE-Template.docxIEEE-Template.docx
IEEE-Template.docx
 
How To Write Your Research Dissertation
How To Write Your Research DissertationHow To Write Your Research Dissertation
How To Write Your Research Dissertation
 
Plantilla IEEE
Plantilla IEEEPlantilla IEEE
Plantilla IEEE
 
Report Writing.ppt
Report Writing.pptReport Writing.ppt
Report Writing.ppt
 
Journal article & publishing lecture 2014
Journal article & publishing lecture 2014Journal article & publishing lecture 2014
Journal article & publishing lecture 2014
 
Technical writing
Technical writingTechnical writing
Technical writing
 
Week6-Sectionsofapaper.ppt
Week6-Sectionsofapaper.pptWeek6-Sectionsofapaper.ppt
Week6-Sectionsofapaper.ppt
 
How to Write a Technical Report
How to Write a Technical ReportHow to Write a Technical Report
How to Write a Technical Report
 
Report Writing Notes.pdf
Report Writing Notes.pdfReport Writing Notes.pdf
Report Writing Notes.pdf
 
Guidelines for final_year_project_report
Guidelines for final_year_project_reportGuidelines for final_year_project_report
Guidelines for final_year_project_report
 
2014 environmental engineeringlabmanual
2014 environmental engineeringlabmanual2014 environmental engineeringlabmanual
2014 environmental engineeringlabmanual
 
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
ENG101 LECTURE 13 TECHNICAL  REPORT.pptxENG101 LECTURE 13 TECHNICAL  REPORT.pptx
ENG101 LECTURE 13 TECHNICAL REPORT.pptx
 
how to write your project documentation
how to write your project documentationhow to write your project documentation
how to write your project documentation
 
Report writing
Report writingReport writing
Report writing
 
Reportch1
Reportch1Reportch1
Reportch1
 
a. Collect at least six published papers in one of the new tre.docx
a. Collect at least six published papers in one of the new tre.docxa. Collect at least six published papers in one of the new tre.docx
a. Collect at least six published papers in one of the new tre.docx
 
Writing engineering report
Writing engineering reportWriting engineering report
Writing engineering report
 
Report Writing Guide
Report  Writing GuideReport  Writing Guide
Report Writing Guide
 
TechnicalPaperWriting_Salman.pdf
TechnicalPaperWriting_Salman.pdfTechnicalPaperWriting_Salman.pdf
TechnicalPaperWriting_Salman.pdf
 
Localization -WritePoint & Net Translators
Localization -WritePoint & Net TranslatorsLocalization -WritePoint & Net Translators
Localization -WritePoint & Net Translators
 

Recently uploaded

Unit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptxUnit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptxVishalSingh1417
 
Understanding Accommodations and Modifications
Understanding  Accommodations and ModificationsUnderstanding  Accommodations and Modifications
Understanding Accommodations and ModificationsMJDuyan
 
Magic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptxMagic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptxdhanalakshmis0310
 
This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.christianmathematics
 
Python Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxPython Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxRamakrishna Reddy Bijjam
 
General Principles of Intellectual Property: Concepts of Intellectual Proper...
General Principles of Intellectual Property: Concepts of Intellectual  Proper...General Principles of Intellectual Property: Concepts of Intellectual  Proper...
General Principles of Intellectual Property: Concepts of Intellectual Proper...Poonam Aher Patil
 
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdfUGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdfNirmal Dwivedi
 
Sociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning ExhibitSociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning Exhibitjbellavia9
 
1029 - Danh muc Sach Giao Khoa 10 . pdf
1029 -  Danh muc Sach Giao Khoa 10 . pdf1029 -  Danh muc Sach Giao Khoa 10 . pdf
1029 - Danh muc Sach Giao Khoa 10 . pdfQucHHunhnh
 
Grant Readiness 101 TechSoup and Remy Consulting
Grant Readiness 101 TechSoup and Remy ConsultingGrant Readiness 101 TechSoup and Remy Consulting
Grant Readiness 101 TechSoup and Remy ConsultingTechSoup
 
Introduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The BasicsIntroduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The BasicsTechSoup
 
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...christianmathematics
 
How to Create and Manage Wizard in Odoo 17
How to Create and Manage Wizard in Odoo 17How to Create and Manage Wizard in Odoo 17
How to Create and Manage Wizard in Odoo 17Celine George
 
ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701bronxfugly43
 
psychiatric nursing HISTORY COLLECTION .docx
psychiatric  nursing HISTORY  COLLECTION  .docxpsychiatric  nursing HISTORY  COLLECTION  .docx
psychiatric nursing HISTORY COLLECTION .docxPoojaSen20
 
How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17Celine George
 
Kodo Millet PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...
Kodo Millet  PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...Kodo Millet  PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...
Kodo Millet PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...pradhanghanshyam7136
 
1029-Danh muc Sach Giao Khoa khoi 6.pdf
1029-Danh muc Sach Giao Khoa khoi  6.pdf1029-Danh muc Sach Giao Khoa khoi  6.pdf
1029-Danh muc Sach Giao Khoa khoi 6.pdfQucHHunhnh
 
The basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptxThe basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptxheathfieldcps1
 

Recently uploaded (20)

Unit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptxUnit-IV; Professional Sales Representative (PSR).pptx
Unit-IV; Professional Sales Representative (PSR).pptx
 
Understanding Accommodations and Modifications
Understanding  Accommodations and ModificationsUnderstanding  Accommodations and Modifications
Understanding Accommodations and Modifications
 
Magic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptxMagic bus Group work1and 2 (Team 3).pptx
Magic bus Group work1and 2 (Team 3).pptx
 
This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.This PowerPoint helps students to consider the concept of infinity.
This PowerPoint helps students to consider the concept of infinity.
 
Python Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docxPython Notes for mca i year students osmania university.docx
Python Notes for mca i year students osmania university.docx
 
General Principles of Intellectual Property: Concepts of Intellectual Proper...
General Principles of Intellectual Property: Concepts of Intellectual  Proper...General Principles of Intellectual Property: Concepts of Intellectual  Proper...
General Principles of Intellectual Property: Concepts of Intellectual Proper...
 
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdfUGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
UGC NET Paper 1 Mathematical Reasoning & Aptitude.pdf
 
Sociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning ExhibitSociology 101 Demonstration of Learning Exhibit
Sociology 101 Demonstration of Learning Exhibit
 
Spatium Project Simulation student brief
Spatium Project Simulation student briefSpatium Project Simulation student brief
Spatium Project Simulation student brief
 
1029 - Danh muc Sach Giao Khoa 10 . pdf
1029 -  Danh muc Sach Giao Khoa 10 . pdf1029 -  Danh muc Sach Giao Khoa 10 . pdf
1029 - Danh muc Sach Giao Khoa 10 . pdf
 
Grant Readiness 101 TechSoup and Remy Consulting
Grant Readiness 101 TechSoup and Remy ConsultingGrant Readiness 101 TechSoup and Remy Consulting
Grant Readiness 101 TechSoup and Remy Consulting
 
Introduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The BasicsIntroduction to Nonprofit Accounting: The Basics
Introduction to Nonprofit Accounting: The Basics
 
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
Explore beautiful and ugly buildings. Mathematics helps us create beautiful d...
 
How to Create and Manage Wizard in Odoo 17
How to Create and Manage Wizard in Odoo 17How to Create and Manage Wizard in Odoo 17
How to Create and Manage Wizard in Odoo 17
 
ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701ComPTIA Overview | Comptia Security+ Book SY0-701
ComPTIA Overview | Comptia Security+ Book SY0-701
 
psychiatric nursing HISTORY COLLECTION .docx
psychiatric  nursing HISTORY  COLLECTION  .docxpsychiatric  nursing HISTORY  COLLECTION  .docx
psychiatric nursing HISTORY COLLECTION .docx
 
How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17How to Give a Domain for a Field in Odoo 17
How to Give a Domain for a Field in Odoo 17
 
Kodo Millet PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...
Kodo Millet  PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...Kodo Millet  PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...
Kodo Millet PPT made by Ghanshyam bairwa college of Agriculture kumher bhara...
 
1029-Danh muc Sach Giao Khoa khoi 6.pdf
1029-Danh muc Sach Giao Khoa khoi  6.pdf1029-Danh muc Sach Giao Khoa khoi  6.pdf
1029-Danh muc Sach Giao Khoa khoi 6.pdf
 
The basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptxThe basics of sentences session 3pptx.pptx
The basics of sentences session 3pptx.pptx
 

Documentation

  • 1.
  • 3. MAIN SECTIONS OF A DOCUMENTATION Methodologies Literature Review System Analysis Introductory & Final Pages Discussion & Results Conclusion Presenting your project made easy
  • 4. INTRODUCTORY PAGES Front Page (Main Cover).  Mansoura University’s logo, Computer and Control Systems Department, Project’s Title, Supervisors Name (s), Team Members Names, Date (M/Y), Sponsors’ logos, and …  This phrase: “A Graduation Project Submitted in the partial fulfillment of B.S. degree in Computer Science & Information Systems.”  Qur’anic Verse / Quote … Presenting your project made easy
  • 5. ABSTRACT Abstract (Preface) …  An Abstract shouldn’t exceed about 200 – 500 words in a paper, and about 2 pages (Maximum) in a Documentation.  The English Abstract should be translated at least into “Arabic.”  Do not cite references in the abstract. Presenting your project made easy
  • 6. ACKNOWLEDGMENT & DEDICATIONS Acknowledgment  The preferred spelling of the word “acknowledgment” in American English is without an “e” after the “g.”  Use the singular heading even if you have many acknowledgments.  Avoid expressions such as “One of us (S.B.A.) would like to thank ... .” Instead, write “F. A. Author thanks ... .” Dedications Presenting your project made easy
  • 7. THE REMAINING INTRODUCTORY PAGES Table of Contents List of …  Figures.  Tables.  Equations. (Optional)  Abbreviations. (Optional) Document Organization (Structure) Chapter 1: Introduction which usually includes sections such as Overview, Motivation, Problem Statement, Objective (s), Scope of the work, Solution Approaches, Tools Used, … etc. Presenting your project made easy
  • 8. CONTENTS OF A LITERATURE REVIEW Reviewing the different scopes and related domains. Reviewing main modules in the selected scope. Reviewing the main approaches and methodologies per module  State implicitly/briefly the Advantages/Disadvantages as reviewed for each approach.  A simple indirect comparative study may be conducted (in tables form).  At least one chapter in the documentation, but may reach three.  An example to illustrate all aspects of literature review: Voice Recognition Presenting your project made easy
  • 9. METHODOLOGIES (PROPOSED SYSTEM) Detail the researched & implemented methods.  Determine the scope of the project in more details.  Use appendices to make a better document structure. Detail any comparative aspects with other approaches. Presenting your project made easy
  • 10. SYSTEM ANALYSIS & DESIGN Only one chapter. Block Diagram. Requirements Specification: System’s Software & Hardware Requirements. Assumptions & Dependencies. Software lifecycle and time plan. UML (Unified Modeling Language) Diagrams.  e.g. Use Case Diagram, Class Diagram, Sequence Diagram, Collaboration Diagram, Activity Diagram, State Machine Diagram, … etc. Presenting your project made easy
  • 11. RESULTS & EXPERIMENTS Conducted Results. Comparative Study against other approaches Presenting your project made easy
  • 12. DISCUSSION & CONCLUSION Discuss the achieved results. Conclude/Summarize the contributions.  A conclusion section is not required. Although a conclusion may review the main points of the paper.  Do not replicate the abstract as the conclusion.  A conclusion might elaborate on the importance of the work or suggest applications and extensions. Future Work. Presenting your project made easy
  • 13. THE REMAINING FINAL PAGES References Appendices Glossary Notes Presenting your project made easy
  • 14. GENERAL GUIDELINES & STANDARDS Nearly all pages should be numbered (Roman/English numbers). Not more than a couple of – formal – fonts per page. Standard indexing & font sizes for paragraphs, sub-titles, sections’ titles, and chapters’ titles (e.g. 12, 14, 16 and 22). Don’t write a paragraph consisting of one line. Usually, in documentations, roman numerals are used only in numbering the introductory pages … English numbers are used to number the whole document starting the chapters. Define all symbols and abbreviations before using them (whether in text or list of abbreviations). Presenting your project made easy
  • 15. GENERAL GUIDELINES & STANDARDS Figures, Tables, and Equations should be indexed, and they have to be referred to within the text. Figure explanation should be below the figures; table explanations should be above the tables. Avoid placing figures and tables before their first mention in the text. Use the abbreviation “Fig. 1,” even at the beginning of a sentence. Do not change the font sizes or line spacing to compress more text into a limited number of pages. Use italics for ensuring ; do not underline. Presenting your project made easy
  • 16. GENERAL GUIDELINES & STANDARDS If you are using Word, use either the Microsoft Equation Editor or the MathType add-on (http://www.mathtype.com) for equations in your paper/document (Insert | Object | Create New | Microsoft Equation or MathType Equation). Use one space after complete sentence and colons. Avoid dangling participles, such as, “Using (1), the potential was calculated.” [It is not clear who or what used (1).] Write instead, “The potential was calculated by using (1),” or “Using (1), we calculated the potential.” Use a zero before decimal points: “0.25,” not “.25.” Indicate sample dimensions as “0.1 cm × 0.2 cm,” not “0.1 × 0.2 cm2.” Presenting your project made easy
  • 17. GENERAL GUIDELINES & STANDARDS The abbreviation for “seconds” is “s,” not “sec.” Do not mix complete spellings and abbreviations of units: use “Wb/m2” or “webers per square meter,” not “webers/m2.” When expressing a range of values, write “7 to 9” or “7-9,” not “7~9.” A parenthetical statement at the end of a sentence is punctuated outside of the closing parenthesis (like this). (A parenthetical sentence is punctuated within the parentheses) Presenting your project made easy
  • 18. GENERAL GUIDELINES & STANDARDS Avoid contractions; for example, write “do not” instead of “don’t.” The serial comma is preferred: “A, B, and C” instead of “A, B and C.” If you wish, you may write in the first person singular or plural and use the active voice (“I observed that ...” or “We observed that ...” instead of “It was observed that ...”). Remember to check spelling. Presenting your project made easy
  • 19. SOME COMMON MISTAKES The word “data” is plural, not singular. The subscript for the permeability of vacuum µ0 is zero, not a lowercase letter “o.” Use the word “whereas” instead of “while” (unless you are referring to simultaneous events). Do not use the word “essentially” to mean “approximately” or “effectively.” Do not use the word “issue” as a euphemism for “problem.” Presenting your project made easy
  • 20. SOME COMMON MISTAKES Be aware of the different meanings of the homophones “affect” (usually a verb) and “effect” (usually a noun), “complement” and “compliment,” “discreet” and “discrete,” “principal” (e.g., “principal investigator”) and “principle” (e.g., “principle of measurement”). Prefixes such as “non,” “sub,” “micro,” “multi,” and “ultra” are not independent words; they should be joined to the words they modify, usually without a hyphen “nonlinear” “non-linear” The abbreviation “i.e.,” means “that is,” and the abbreviation “e.g.,” means “for example” (these abbreviations are not italicized). Presenting your project made easy
  • 21. Everything that is or was, Began with a dream