0% found this document useful (0 votes)
115 views37 pages

Technical Documentation in Software Development

This document outlines the sections and content required for a project proposal for a COMSCI 2201 Systems Analysis and Design course. It includes sections for the project title, group members, date submitted, problem domain and objectives, literature review of existing systems, proposed methodology like SDLC phases, results and discussion, and references in APA format. The methodology section describes planning, analysis, design, implementation, support and maintenance phases. Requirements for each section like problem statement, objectives, scope, and limitations are provided.

Uploaded by

mleighraven
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)
115 views37 pages

Technical Documentation in Software Development

This document outlines the sections and content required for a project proposal for a COMSCI 2201 Systems Analysis and Design course. It includes sections for the project title, group members, date submitted, problem domain and objectives, literature review of existing systems, proposed methodology like SDLC phases, results and discussion, and references in APA format. The methodology section describes planning, analysis, design, implementation, support and maintenance phases. Requirements for each section like problem statement, objectives, scope, and limitations are provided.

Uploaded by

mleighraven
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
You are on page 1/ 37

COMSCI 2201

 This page should contain:

Complete title of the project


Name of Group Members
“In partial fulfillment of the requirements in
COMSCI 2201 Systems Analysis and Design”
Date submitted
 This section gives an overall view of your project proposal. The content
must mention the following:

The problem domain/scope


The project output (What you want to develop)
Objective and potential impact of the project
Identity of project sponsor (if applicable)
Description of setting and organizational background
 This chapter should be able to elaborate on the following sections:

A. Statement of the Problem


 What initiated the project? What are the factors that triggered the project
(internal or external)?
 Could be (which is applicable among these?):
(a) Current relevant organizational gaps
To fill some immediate need that comes up correction of problems(organizational
problems)
(b) Improvements/enhancements to the current running systems
Upgrading systems
Altering systems
Installing new systems
(c) Requests by users/clientele for systems development initiative
(d) Part of strategic plan of the organization
Based on mission or objective statement, come up with some
competitive business strategy
(e) Projects may also be initiated due to some outside force
(f) Etc.(refer to notes)
A. Statement of the Problem
 What your project will address?
- Documentation of the Existence and/or Seriousness of the
Problem
- Documentation of current system/s (if any)
- Problem/s identified with the existing systems
- Process models of existing systems contributing to the problem
- Data models of existing systems
A. Statement of the Problem (cont…)
 Data (or any form of statistics) that may be relevant to prove existence and
seriousness of the identified problems.
Example:
ISSUES WEIGHT

1) The daily sales of drinks and food offered by the café are being recorded manually 3
by the cashiers
2) All the payment transactions of the boarders are being recorded manually in a 2
record book.
3) The record of the sales in the canteen such as the groceries and meals, are being 1
recorded manually in a notebook.
B. Objectives of the Study
- General Objective
- Enumerate specific objectives (specific objectives should be
attained by the enumerated methodologies)
C. Scope and Limitation
Scope – amount of detail and information included in the system.
What are the modules to be included in the system?
Limitation – shortcomings, conditions or influences.
What are the functionality that is NOT included in the system?
D. Importance of the Study
- Expected benefits: anticipated tangible and intangible benefits and a
timetable that shows when they are to occur.
E. Definition of Terms (optional)
- Define technical terms to be used on your project.
- Terms used in the study are operationally defined for better understanding.
 Discussions on related publications, projects, researches.
 Survey of existing systems/projects, or previously developed
projects.
What are the technologies/development strategies/programming
techniques applied/utilized in the studied projects or previously
documented systems?
How did the studied systems/projects improved/benefited users?
What ideas/concepts do these existing projects have which will
be used in your project?
What are the components of these existing projects that needs to
be emphasized and discussed?
What concepts/ideas/designs/implementation
strategies/characteristics have you seen in these projects that needs
to be discussed and referred to by your project?
What are the similarities/differences of these existing projects?
How similar is your project to these existing projects?
How different is your project to these existing projects?
How did your project improve these existing projects?
How different is your project from these existing or previously
developed projects?
How will your project improve the status of these current/previous
studies/projects/research?
Refer to Word Document: “Guidelines in Citing Related Literature or Existing Alternatives”
 SCRUM Methodology
 SDLC with 7
phases
 SDLC with 5 stages
 PPDIO – this is applicable
with major in Network
Administration or with
Internet of Things (IOT)
project.
1.PLANNING

Conduct of Preliminary Investigation


Includes data gathering, interviews, brainstorming, study of current
operations, document review, observations
Fact-finding which includes conduct of interviews
Review and assessment of existing alternatives (how do users
currently cope with the problem? (Assess the best available resources
for addressing the problem)
1.PLANNING (cont…)

 Gantt Chart/Network Diagram


 Fish Bone Diagram/Cause and Effect Diagram
 Creating the Conceptual Framework (description of the system as you currently
envision it)
 Determining project scope and constraints
 Determining project roles
- Lists the people who will participate in the project, and describe each person’s role
2. ANALYSIS

Analysis of the gathered


data
System Requirements
Checklist
- What features you want for the
system to have: input
definitions, processes, outputs,
controls, performance?
2. ANALYSIS (cont…)

 Feasibility studies: technical, operational, economic


 Future growth
 Costs (Total Cost of Ownership)
 Benefits (Tangible or Intangible)
 Process Flow Diagram (Manual Process)
 Process Descriptions/Specifications
3. DESIGN
 Context Diagram; Data Flow Diagram; Exploded Diagram
 Use Case Diagram
 Data models
- ER Diagram
- Relational Data Model
 User Interface Design
- Create a dialog tree to visualize the interface structure of your system
- What principles of user-centered design are applied in your project?
- It can either be wireframe, mockup, or prototype.
3. DESIGN (cont…)
 Input Design
- Sample input forms/source documents presently used in the organization
which will be the basis of your input designs
- For every input design, discuss what and how the input design objectives are
met
- Input methods to adopt
- Design of source documents (if applicable)
3. DESIGN (cont…)
 Output Design (Screen and printed forms of output)
- Sample reports/outputs presently produced by the organization which will
be the basis of your output designs.
- New outputs/reports that can be generated by the system
- Detail and exception reports/outputs
- Discuss what and how the output design objectives are met in your project
3. DESIGN (cont…)
Output Design (Screen and printed forms of output)

- For every output discuss the following:


What is the purpose of the output?
Who wants the information, why is it needed, and how will it be used?
What specific information will be included?
Will the output be printed, viewed on-screen, or both? What type of device will the output go to?
When will the information be provided, and how often must it be updated?
Do security or confidentiality issues exist?

- The use of specialized forms of outputs


- Output control and security
4. IMPLEMENTATION
- Implementation activities include the following:
 Coding
 Testing
 Documentation
 Management Approval: presenting results to management
 System Installation and Evaluation
 Provide training for users
 Perform data conversion and system changeover
5. SYSTEMS SUPPORT AND MAINTENANCE
- You can suggest ways/strategies of possible system support and maintenance activities:
 User training/training of possible new users
 Help Desk
 Online chat support
 Corrective Maintenance activities
 Adaptive Maintenance activities
 Perfective Maintenance activities
 Creating/Managing a maintenance team
 System security measures
 Data backup and recovery strategies
 Identify issues on facing the future challenges and opportunities
 Show and discuss the results your methods.
 For each method, answer the following questions:
RESULTS:
 What was the output of performing the method you mentioned in your
methodology?
 What did you see?, What happened?, What came out? What was the result?
DISCUSSION:
 Interpretation, discussions of the results
 What does the result means?
 The significance of what happened
 What/How/Why caused the produced result.
 A conclusion is the last paragraph in your research paper.
 Conclusion is the chronological end of any discussion. It is the stopping point of a
detailed argument.
 This is a place where final decisions or arguments are made.
 Suggestions for further System enhancements/improvements.
 In the References, you list your references alphabetically by the first author's last name.
 Different rules apply for different kinds of publications.
 Follow APA Style of Citation 7th Edition.
 Alphabetically arranged.

Examples:
1. Aitken, A., & Ilango, V. (2013). A comparative analysis of traditional software
engineering and agile software development. In System Sciences (HICSS), 2013 46th
Hawaii International Conference on (pp. 4751-4760). IEEE.
2. United States Department of Agriculture. (2021). i-Tree: Tools for assessing and
managing community forests. Retrieved from https://www.itreetools.org/.
3. Bulaong, E., & Paz-Alberto, A.M. (2020). Estimation of Tree Canopy Cover in Central
Luzon State University Using Satellite Imageries and GIS. In Proceedings of the 2020
Asian Conference on Remote Sensing (ARCS2020).
A. Tables and figures
-Verbose enough (more than 1 page figures or tables) to impede the smooth flow
of discussions in the main body of the project documentation.
B. Proofs of organizational existence and documentations of consultations/interviews
made (pictures, sample documents, receipts etc.)
C. Sample outputs/reports produced by the System
 Typeface and size:
 Serif fonts size 12 (preferably Times New Roman or Bookman Old Style)for text.
 Sans-serif fonts size 12/14 (preferably any of the following: Tahoma, Arial,
Helvetica) for chapter/section/subsection heading.
 Margins: 1.5” top and left, 1.0” right and bottom
 Paper size: 8.5”x11.0”
 Left-justified. First line indented 0.5” from left margin
 Double-spaced. Entire document except tables/graphs/figures.
 Section Numbering: Follow the format as presented in the project outline.
 Figure/Table Labeling and Numbering: Centered below the figures/centered above the
tables.
The following requirements will be needed in complying with the first project
deliverables:

1. The group members that you will form in this requirement will come from the
groups you have formed on the topic "Business Modeling".
2. The group leader will be the one who will communicate with me, then he/she
will communicate with the group members in relation to my advice/comments.
3. The group will now draft the initial documentation of the project (at this time,
CHAPTER 1 and CHAPTER 2) which conforms with the given format I have
discussed and posted on the Google Classroom.
4. Make sure that all group members will cooperate on the completion of this
requirement (report to me if who are your groupmate/s who didn't participate).
5. Submit the documentation in hard copies on or before May 12, 2023 (Friday).
 Before submitting your document, make sure that it has been edited
for any grammatical, spelling, and punctuation errors, or any
composition-related shortcomings.
 Incomplete/erroneous document will be considered void.

You might also like