technical documentation_cycle manager mobile app
TRANSCRIPT
of the
Cycle Manager
Mobile App
October 2016
Cycle Manager Page 2 of 8
TABLE OF CONTENTS Page
ACRONYMS AND OTHER TERMS ------------------------------------------------------------ 3
1.0 OBJECTIVE, SYSTEM OPERATION AND EXECUTIVE SUMMARY ---------- 4
1.1 OBJECTIVE ---------------------------------------------------------------------------------- 5
1.1.1 Technologies Applied ---------------------------------------------------------- 5
1.2 SPECIFICATION ---------------------------------------------------------------------------- 5
1.3 SUMMARY ----------------------------------------------------------------------------------- 6
2.0 EXECUTION ------------------------------------------------------------------------------------- 7
2.1 CLASSES ------------------------------------------------------------------------------------- 8
Cycle Manager Page 3 of 8
ACRONYMS AND OTHER TERMS
1 SE Standard Edition
2 SDK Software Development Kit
3 SQL Structured Query Language
4 XML Extensible Mark-up Language
Cycle Manager Page 4 of 8
Section 1.0
OBJECTIVE, SPECIFICATION AND SUMMARY
Cycle Manager Page 5 of 8
1.1 OBJECTIVE
Cycle Manager is a mobile app that is based on the Billings Method. Imagine a method of
family planning that is simple, natural, harmless, 99.9% effective, beneficial to
communication within a monogamous relationship, and in keeping with one's relationship
with God. That is what The Billings Method offers. It is a method that will not harm a
woman's future fertility, and will help a woman determine when she is fertile (great for
couples having trouble conceiving). It is also an invaluable and drug-free way to avoid
pregnancy. In fact, it is a method that works. The Billings Method does require discipline
and diligence, especially in the beginning, but eventually it becomes second nature.
Cycle Manager is an app designed to help every woman implement the Billings Method
effectively. For years, implementing the Billings Method has been cumbersome for most
women in the sense that it has been done mainly on paper – diaries, calendars, menstrual
charts etc. Cycle Manager has changed all that as women would now have to chart their daily
body signs on their mobile devices, thereby eliminating the inconveniences of having to chart
on paper. Above all, Cycle Manger has additional and interesting features that make charting
easy and fun.
As of now, the app design for the Android®
platform has been concluded: it can be installed
in Android devices of version 4.1 (API 16, Jelly Bean) and above. However, release of this
app will only be done when the respective designs for the Windows® and IOS
® platforms
have been concluded.
1.1.1 Technologies Applied
Embedded Systems Design, Java SE SDK, Android SDK, Digital Logic Techniques, XML,
SQL etc.
1.2 SPECIFICATION
Cycle Manager mobile app was designed to help every woman implement the Billings
Method effectively. This is a simple, natural and drug-free way to determine when one is
fertile or not. An internet connection is not required to use the app: all daily charting records
are saved in a specially compressed file within the mobile device. This app encompasses
more than a mere menstrual calendar as it is enriched with interesting features and one of the
key essences of the app is user friendliness. Consequently, incorporating these rich features
was inspired by the following specifications:
APP MUST BE AS SMART AS POSSIBLE
a) Users should input just little information for charting: that is only as much information as
it is necessary; while the app must deduce the rest of the required information.
b) It must take less than one minute duration for a user to save a chart record, this duration
being the time period starting from when the user commences data input and when data is
eventually saved.
DAILY CHARTING SHOULD BE EASY
c) For daily chartings, users do not have to start the app themselves and users do not have to
remember about the app: the app must be able to start automatically every day at a time
pre-set by the user or at a default time if the user has not yet set a time for daily charting.
Cycle Manager Page 6 of 8
d) Even when the device has been turned off, the app must be able to re-establish the pre-set
time for daily charting (or the default time if there is no pre-set time yet) upon the next
device booting.
NEXT BEGINNING OF MENSTRUATION MUST BE DEDUCED WELL IN
ADVANCE
e) So as to be adequately prepared well ahead of time, the app must be able to deduce and
furnish users with a projected date of the beginning of their next menstruation. This
projected date information must be available as from the day the user charts in the current
menstrual occurrence.
f) Once a projected date of the next menstruation has been provided, users should be able to
choose whether or not to set a menstruation reminder alarm based on the projected date.
HISTORICAL INFORMATION SHOULD EASILY BE ACCESSIBLE
g) Historical data (saved charting records) must be easily accessible and should be presented
to the user once the app opens. The most recently saved ones should be presented firstly.
h) Saved data must be accessible either sequentially or randomly in accordance with users’
choice.
IMPORTANT STATISTICAL INFORMATION MUST BE DEDUCED
i) Based on historical data (save charting records), users should be able to deduce important
statistical data, especially those frequently demanded for by gyneacologists.
Consequently, within pre-set dates users must be able to obtain the following statistical
information from the app:
Frequency of sexual activities.
Frequency of visitations to the doctor.
Furthermore, within a pre-set period, the last date of occurrence of each of the cycle
states (these cycle states are outlined by the Billings Method) must be made available
by the app.
THE APP MUST BE ABLE TO BACK UP SAVED RECORDS
j) User should be able to back-up her historical data (saved charting records) anytime by
exporting the data to a text file format.
APP MUST INCORPORATE A HELP SECTION
k) The help section of the app must contain invaluable literatures on each of the cycle states
as well as a quick start guide on how to use the app. All menu items in the app must be
thoroughly explained in simple language in this section.
1.3 SUMMARY
Presently, the app design for the Android® platform has been concluded: it can be installed in
Android devices of version 4.1 (API 16, Jelly Bean) and above. However, release of this app
will only be done when the respective designs for the Windows®
and IOS® platforms have
been concluded.
Cycle Manager Page 7 of 8
Section 2.0
EXECUTION
Cycle Manager Page 8 of 8
2.1 CLASSES
In all, seventeen (17) Java classes (totaling over 7500 lines of Java code) were developed for
this app and they encompass all aspects of the app: the screens, user-interfaces, multimedia
items, database connection, menu items and their functionalities etc.
To have an idea of the app’s look and feel, please see this document:
http://www.slideshare.net/EmmanuelChidinma/select-menu-items-and-screenscycle-manager-
mobile-app-67724234