Embed Size (px)
Citation preview
User Manual
Kisiipoly Android Apps
May 2019
Revision Sheet
User’s Manual Page i
User’s Manual Page ii
User’s Manual
Authorization Memorandum
I have carefully assessed the User’s Manual for Kisiipoly android applications. This document has been
completed in accordance with the requirements of System Development Methodology.
We fully accept the changes as needed improvements and authorize initiation of work to proceed. Based
on our authority and judgment, the continued operation of this system is authorized.
ALEX MARAGA 5th May 15, 2019
___________ ________________ ____________
NAME DATE
Project Leader
COLLINS JUMAH 5th May 15, 2019
_______________________________ _____________________
NAME DATE
Operational
User’s Manual Page iii
USER'S MANUAL
TABLE OF CONTENTS
Page #
A. Preface ........................................................................................................................................... A-1
B. Audience ........................................................................................................................................ B-2
C. Typographic Conventions ............................................................................................................. C-3
D. GENERAL INFORMATION........................................................................................................ D-1
1.1 System Overview.................................................................................................................. D-1
1.2 Project References ...................................................................................................................... D-2
1.3 Authorized Use Permission ........................................................................................................ D-2
1.4 Points of Contact ......................................................................................................................... D-2 1.4.1 Information ................................................................................................................................... D-2 1.4.2 Coordination ................................................................................................................................. D-2 1.4.3 Help Desk ..................................................................................................................................... D-2
1.5 Organization of the Manual ....................................................................................................... D-2
1.6 Acronyms and Abbreviations .................................................................................................... D-2
E. SYSTEM SUMMARY ................................................................................................................... E-1
2.1 System Configuration .......................................................................................................... E-1
2.3 Overview of the Apps .......................................................................................................... E-1
F. GETTING STARTED ................................................................................................................... F-1
3.1 Installation ............................................................................................................................ F-1
G. 4.0 App workflow ........................................................................................................................... G-6
4.1 [Main Website App UI] ....................................................................................................... G-6 4.1.1 Home Page ......................................................................................................................................... G-6 4.1.2 Main Menus ........................................................................................................................................ G-7 4.1.3 Access content .................................................................................................................................... G-7
4.2 Library App UI ........................................................................................................................... G-9 4.2.1 Main home page ................................................................................................................................. G-9 4.2.2 Main Menu ....................................................................................................................................... G-10 4.2.3 Content Access ................................................................................................................................. G-11
4.3 e-Learning Application ............................................................................................................ G-15 4.3.1 Home Page display ........................................................................................................................... G-15 4.3.2 Main Menu ....................................................................................................................................... G-15 4.3.3 App Content ...................................................................................................................................... G-16
5.0 Special Instructions for Error Correction ..................................................................................... G-19
5.1 Caveats and Exceptions ............................................................................................................ G-19
1.0 General Information
User’s Manual
A. PREFACE
About This Guide
This document provides information about the services and functions available with the Mobile Android
App and how to access them.
1.0 General Information
User’s Manual
B. AUDIENCE
This guide is intended for people who want to use their Android phone to access remote interactive
services for the Kisiipoly Institution. The services available are: Website services, Library Services and
the e- Learning platform.
1.0 General Information
User’s Manual
C. TYPOGRAPHIC CONVENTIONS
This document uses the following typographic conventions to help you locate and identify information:
Italic text: Identifies new terms, emphasis, and book titles.
Bold text: Identifies button names and other items that you can click or touch in the graphical user
interface or press on a computer keyboard
Normal text: Identifies text to enter on the keyboard Note: Notes provide extra information about a topic
that is good to know but not essential to the process.
CAUTION: Cautions draw your attention to actions that could compromise the security of your system or
result in the loss of data.
1.0 General Information
User’s Manual
1.0 GENERAL INFORMATION
1.0 General Information
User’s Manual Page D-1
The User’s Manual provides the information necessary for the user to effectively use the android
applications.
D. GENERAL INFORMATION
1.1 System Overview
Kisiipoly Apps
Android Applications.
Build using Android Studio version 3.4.0
Support and run in all android operating systems.
Version: Supports android version 4.4 (KitKat) and latest versions.
API level: Support API Level 19 and latest.
Testing: Tested using latest google tools i.e. google analytics, Mixpanel e.t.c for performances.
Application Category:
i. Kisiipoly Main Site App
ii. Kisiipoly Library App
iii. Kisiipoly E-Learning App
Operational status:
Partially Operational
Under development due to the change in technological tools.
The applications are verified by play protect.
1.0 General Information
User’s Manual Page D-2
1.2 Project References
References that were used in preparation of this document in order of importance to the end user.
The main content obtained from main android developers site .
1.3 Authorized Use Permission
KOFRICA provides you with access to the use of the application. The applications will be up to date with
the new technology tools. Updates may be done without your notice but there will be no interaction with
your data or any performances.
1.4 Points of Contact
1.4.1 Information
The points of organizational contact (POCs) that may be needed by the document user for informational
and troubleshooting purposes are.
Email: [email protected] Email: [email protected]
Phone: +254712144030 Mobile: +254790366848
1.4.2 Coordination
The list of organizations that require coordination between the project and its specific support function
(e.g., installation coordination, security, etc.) are as section 1.4.1. of this document.
1.4.3 Help Desk
Help desk information including responsible personnel phone numbers for emergency assistance can be
referred to section 1.4.1.
1.5 Organization of the Manual
User’s Manual v0.01.
The manual is categorized into three critical parts.
i. Kisiipoly main Site App
ii. Kisiipoly Library app
iii. Kisiipoly e-Learning App
1.6 Acronyms and Abbreviations
Provide a list of the acronyms and abbreviations used in this document and the meaning of each.
App: Application
URL: Uniform Resource Locator
2.0 System Summary
User’s Manual
2.0 SYSTEM SUMMARY
2.0 System Summary
User’s Manual Page E-1
E. SYSTEM SUMMARY
This section provides a general overview of the system written in non-technical terminology. The
summary outline the uses of the application, access of the application in supporting the activities of the
user and staff.
2.1 System Configuration
The Kisiipoly eResources is an online platform for acquiring electronic learning materials.
The materials are categorized into:
i. Journals
ii. E-Books
iii. E-Resources
The platform is web based.
For site audit, the following have been tested by the developers to identify and fix common
problems that might affect the site:
i. Site performance
ii. Best practices
iii. Accessibility
iv. SEO (Search Engine Optimization).
v. User experience.
Data storage:
All data submitted by the users are stored in MySQL database. Data security has been
performed to ensure no data is accessible by unauthorized users.
2.3 Overview of the Apps
The Mobile Android App allows you to access a core set of services offered at Kisii National Polytechnic.
The apps are designed to be easy to use, so it contains only the essential functionality available in the
web.
This application reflects the whole website services as described in the next chapter.
3.0 Getting Started
User’s Manual
3.0 GETTING STARTED
10.0 Appendix
User’s Manual
F. GETTING STARTED
This section provides a general walkthrough of the system from initiation through exit. The logical
arrangement of the information shall enable the functional personnel to understand the sequence and flow
of the system. We Use screen prints to depict examples of text under each heading.
3.1 Installation
Obtain the apps from google play store using the link.
https://play.google.com/store/search?q=kisiipoly&c=apps
Figure 1 showing kisiipoly android apps from google play
After selecting on the application to click on the ‘INSTALL’ green button as shown
10.0 Appendix
User’s Manual
Figure 2 shows install button “Click on the button”
Figure 3 showing download starts
10.0 Appendix
User’s Manual
10.0 Appendix
User’s Manual
Great job! Your app is compatible with your device and successfully installed. Lets’ see next.
Click open button to get started.
10.0 Appendix
User’s Manual
APP WORKFLOW
10.0 Appendix
User’s Manual
G. 4.0 APP WORKFLOW
This section describes in general use of the applications. The functionalities and the menus
describing each role. Terms the application menus first encountered by the user, as well as the
navigation paths to functions noted on the screen.
4.1 [Main Website App UI]
This section provide general overview and the outlook of the application installed by the user in section
3.0.
4.1.1 Home Page
10.0 Appendix
User’s Manual
Figure 1 showing app main interface.
4.1.2 Main Menus
Figure 2 showing main menus
To access the app menus, click on the top left 3 horizontal lines, the menu will toggle and be displayed.
4.1.3 Access content
User can access all site functionalities through the menus. Take a look at the examples below
Example 1
How view academic department? On the menu, click Academic Department, this will display all the
academic departments in the institution as shown.
10.0 Appendix
User’s Manual
Figure showing departments when department menu is clicked.
Example 2
Figure 3 showing downloads user can access
Example 3
10.0 Appendix
User’s Manual
4.2 Library App UI
Following the installation procedure, download Library app and install in your android device.
4.2.1 Main home page
10.0 Appendix
User’s Manual
After installation, your home page should appear like the figure above.
4.2.2 Main Menu
The application menu is located on top-left corner Click on the menus above to see available
functionalities.
10.0 Appendix
User’s Manual
4.2.3 Content Access
To access the content, click on the menu items as shown above.
10.0 Appendix
User’s Manual
Figure showing contact in the library when user clicks in the menu items above.
10.0 Appendix
User’s Manual
Figure 4 showing user e-Resource access via the application.
Figure showing access to Library FAQ.
10.0 Appendix
User’s Manual
Figure showing library policies
Figure showing security in the library
10.0 Appendix
User’s Manual
4.3 e-Learning Application
Following the installation procedure, download e-Learning mobile app and install in your android device.
4.3.1 Home Page display
After successful installation, your app should look something like.
4.3.2 Main Menu
The application menu is located on top-left corner Click on the menus above to see available
functionalities.
10.0 Appendix
User’s Manual
4.3.3 App Content
To access the content, click on the menu 4.3.2
Figure showing kisiipoly e-Learning courses
Figure showing e-Learning Site
10.0 Appendix
User’s Manual
Figure showing eLearning FAQ guide
10.0 Appendix
User’s Manual
5.0 ERROR HANDLING
10.0 Appendix
User’s Manual
5.0 SPECIAL INSTRUCTIONS FOR ERROR CORRECTION
As a condition of your use of the Services, you will not use the Services for any purpose that is
unlawful or prohibited by these terms, conditions, and notices. You may not use the Services in
any manner that could damage, disable, overburden, or impair any performance, or the
network(s) connected to any.
Some functionalities may not work in phone android version 4.4 due to the Unsupported app
version, otherwise all other versions are compatible with the application.
5.1 Caveats and Exceptions
The services that KOFRICA provides to you are subject to the following Terms of Use ("TOU"). The right to update the application at any time without notice to you, without interfering with any data
and other system functionalities.
The application will be updated as per the new release of the new trends, following the google playstore
policy.
10.0 Appendix
User’s Manual Page G-1
End
Thank you!
Prepared By Kofrica
