0% found this document useful (0 votes)
96 views3 pages

Systems Documentation Outline

This document outlines the structure and contents of a systems documentation project report. It includes 5 chapters that will cover: an introduction to the study, a literature review of the existing system, analysis and design of the proposed system, implementation and documentation of the new system, and a conclusion. Preliminary pages such as a title page, declaration, and acknowledgements are also included. The report will document all aspects of developing a new "XXXX" system to replace an existing one.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
96 views3 pages

Systems Documentation Outline

This document outlines the structure and contents of a systems documentation project report. It includes 5 chapters that will cover: an introduction to the study, a literature review of the existing system, analysis and design of the proposed system, implementation and documentation of the new system, and a conclusion. Preliminary pages such as a title page, declaration, and acknowledgements are also included. The report will document all aspects of developing a new "XXXX" system to replace an existing one.
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

SYSTEMS DOCUMENTATION OUTLINE

PRELIMINARY PAGES
i. TITLE PAGE
ii. DECLARATION
iii. DEDICATION
iv. ACKNOWLEDGEMENT
v. TABLE OF CONTENTS
vi. LIST OF FIGURES
vii. ABSTRACT

CHAPTER ONE: INTRODUCTION


1.0 Introduction
1.1 Background to the Study
1.2 Statement of Problem
1.3 Aim and Objectives
1.4 Purpose of the Study
1.5 Scope of the Project
1.6 Definition of terms

CHAPTER TWO: LITERATURE REVIEW


2.0 Introduction
2.1 Development of “XXXX” System
2.2 Features of “XXXX” System
2.3 Needs for “XXXX” System
2.4 ERD/UML/Use Case Diagrams for “XXXX” System
2.5 Review of Challenges and Gaps in the existing “XXXX” System

CHAPTER THREE: SYSTEM ANALYSIS AND DESIGN


3.0 Introduction
3.1 Information Gathering
3.2 Analysis of Existing system
3.2.1 Problems of Existing system
3.2.2 Description of Proposed system
3.2.3 Advantages of Proposed system
3.3 Design and implementation Approach
3.3.1 Software Requirements
3.3.2 Hardware Requirements
3.4 System Development Methodology
3.4.1 “XXX” MODEL
3.4.2 Requirement analysis and system design

PREPARED BY: RACHEAL MAINA 0724947911


3.4.3 Architectural design
3.4.4 Advantages
3.4.5 Disadvantages
3.5 Dataflow Diagrams
3.6 Testing

CHAPTER FOUR: SYSTEM IMPLEMENTATION AND DOCUMENTATION


4.0 Introduction
4.1 Implementation of the system
4.2 Hardware support
4.3 Software support
4.4 Documentation of the system
4.4.1 Program documentation
4.4.2 Procedure design
4.4.3 Operating system
4.5 Input and Output design
4.5.1 Home page
4.5.2 Admin/User Login
4.5.3 etc
4.6 Database design
4.6.1 User table
4.6.2 ALL other tables used

CHPATER FIVE: SUMMARY, CONCLUSION AND RECOMMENDATION


5.0 Introduction
5.1 Summary
5.2 Conclusion
5.3 Recommendation

REFERENCES
APPENDICES

1. Budget
2. Source Code

NB:
1. The title page should not have a page number.
2. Preliminary pages should have roman page numbers.
3. The margins of your document should be as follows
a. Top 1’ c. Right 1’
b. Bottom 1’ d. Left 1.5’

PREPARED BY: RACHEAL MAINA 0724947911


PRELIMINARY PAGES

TITLE PAGE
“XXXX” SYSTEM

BY

NAME

A SYSTEM PROJECT REPORT SUBMITTED TO THE DEPARTMENT OF……….IN


THE SCHOOL OF BUSINESS IN PARTIAL FULFILLMENT FOR THE
DIPLOMA/DEGREE OF ………OF JOMO KENYATTA UNIVERSITY OF
AGRICULTURE AND TECHNOLOGY;

YEAR
i. DECLARATION
This proposal/project is my original work and has never been presented for a diploma/degree in
any other university
Students name
Reg No
……………………… ……………………
Signature Date

This proposal/project has been submitted for examination with my approval as University
Supervisor
Lecturers name
…………………….. …………………
Signature Date

ii. DEDICATION
I dedicate this project to………

iii. ACKNOWLEDGEMENT
Should include a paragraph acknowledging the individuals who played a role during your
research period eg management of the case study, parents, friends, supervisors, lecturers etc.

PREPARED BY: RACHEAL MAINA 0724947911

Common questions

Powered by AI

Racheal Maina's documentation emphasizes the importance of identifying problems in the existing system (Section 3.2.1) and proposing solutions with a new system description in Section 3.2.2. This phase is significant as it lays the groundwork for justifying changes and guiding the development of solutions that address identified gaps effectively.

The introduction chapter in Racheal Maina's systems documentation includes several key elements: 1.0 Introduction, 1.1 Background to the Study, 1.2 Statement of Problem, 1.3 Aim and Objectives, 1.4 Purpose of the Study, 1.5 Scope of the Project, and 1.6 Definition of terms.

Racheal Maina's documentation outlines that the scope of a systems project should be clearly defined as part of the introduction chapter under section 1.5, detailing the boundaries within which the project is developed, including limitations and constraints specific to the study or system.

In Racheal Maina's documentation, use case diagrams and ERD/UML diagrams play a key role in system design by mapping out system interactions and data relationships (Section 2.4). These diagrams help visualize system functionality and interactions, thereby enhancing the evaluator's understanding of the system’s planned operations and data flow.

In system implementation, Racheal Maina outlines considerations for hardware and software support in sections 4.2 and 4.3. Hardware support must address the needs of the system’s operational environment, whereas software support ensures compatibility and functionality necessary for implementing the system effectively.

Preliminary pages in Racheal Maina's documentation structure, such as the title page, declaration, dedication, acknowledgement, and table of contents, serve to formally introduce the document, provide essential formalities, and guide the reader through the document's structure. They establish the document's credibility and ensure the reader is well-oriented before delving into the core contents.

Racheal Maina suggests the use of the "XXX" Model as a system development methodology in the documentation. She includes requirement analysis and system design, architectural design, and outlines the advantages and disadvantages of the proposed model. Advantages and disadvantages are discussed in sections 3.4.4 and 3.4.5, providing evaluative insights into the methodologies.

Racheal Maina's documentation presents database design structure to include various tables such as the User table and others pertinent to the system's functionality. It integrates with user requirements by ensuring that each table supports necessary data for specific system processes, providing a comprehensive structure that enables seamless data management, as outlined in section 4.6.

Racheal Maina's documentation outlines that the summary, conclusion, and recommendation section (Chapter Five) consist of: 5.0 Introduction, 5.1 Summary, 5.2 Conclusion, and 5.3 Recommendation.

Racheal Maina addresses input and output design as an integral part of system documentation in section 4.5. It includes designing interfaces such as the home page and admin/user login, ensuring that data capture and presentation meet usability needs effectively.

You might also like