Technical Documentation in Software Development
Technical Documentation in Software Development
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
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.