User Requirements Document

Transcription

1 User Requirements Document Version: 1.5 Project Team ander Alewijnse Alex ten Brink Quirijn Bouts Xixi Lu artin Rooijackers Rob egers Janôt ijen Robin Wolffensperger Project anager Quality Assurance anager enior anagement Advisor ustomer Nicky Gerritsen Edin Dudojević ark van den Brand Lou omers Erik Luit Henny van Alphen February 24, 2011

2 1

3 Abstract This is the User Requirements Document (URD) for the ineption project group. These user requirements were established according to requests formulated by ineption taking into account the wishes of our customer, Henny van Alphen, functional manager of the ommunicatie en Expertise entrum at Eindhoven University of Technology. It is written according to the oftware Engineering tandard as set by the European pace Agency [2].

4 ontents 1 Introduction Purpose cope List of definitions List of references Overview General description Product perspective General capabilities ain application ap Agenda News Encyclopedia Handbook Facebook Twitter Employee finder Additional social media requirements Extendability aintainability General constraints User characteristics tudents Application maintainers Environment description Other systems in the environment Platform Assumptions and dependencies pecific requirements apability requirements General ain app ap-app

5 3.1.4 News-app Agenda-app Employee-finder-app Encyclopedia-app tudent handbook-app Facebook-app Twitter-app onstraint requirements General ap-app News-app Agenda-app Person-finder-app Encyclopedia-app tudenthandbook-app

6 Document tatus heet Document status overview General Document title: User Requirements Document Identification: URD Author: ander Alewijnse, Rob egers, Robin Wolffensperger Version: 1.5 Document status: Approved Document history Version Date Reason for change Initial version Requirements edited and added Internal review Group comments ustomer review ustomer review 2 3

7 Document hange Records since previous issue General Document title: Identification: User Requirements Document URD hanges Page(s) Paragraph(s) Action All All reated hapter 3 Requirements edited and added 5-24 Title page, 1.3, 1.4, hapter 2-3 Process remarks 5, 6, , 1.4, hapter 3 Process group comments 5, 6, , 1.4, hapter 3 Process customer comments 6, 9, 10,13, , 2.2, 3.1, 3.2 Process customer comments 4

8 hapter 1 Introduction 1.1 Purpose The user requirements document (URD) contains the requirements for insapption. These requirements are a negotiated agreement between the E at Eindhoven University of Technology and ineption. Listed requirements, and only these, will be implemented in insapption, according to their priorities. Any changes to these requirements require the full consent of both parties. 1.2 cope insapption is an application designed and developed by the ineption project group for the E at the Eindhoven University of Technology. The purpose of the application is to familiarize new students with the campus and facilities of the Eindhoven University of Technology. The application is made for a smart phone running Android version 2.3 and contains several apps within it, such as a navigation device, news feed and student guide. The app is designed in such a way that it is easy to add new apps to the application. 1.3 List of definitions Administrator Android API App(lication) alendar view E Edge EA Event External resource pecial user that maintains the application. Android is a mobile operating system. An application programming interface (API) is a particular set of rules and specifications that a software program can follow to access and make use of the services and resources provided by another particular software program that implements that API. A program or group of programs designed for end users. A display in which all days of the selected month are shown chronologically. ommunicatie en Expertise entrum. A connection between two vertices (ee vertex). European pace Agency. Item in one of the feeds regarding the agenda of the TU/e. Information maintained by third parties. 5

9 Facebook page A page on facebook.com. The information on such a page is maintained by a specific user such as the TU/e ( It may also include messages from other Facebook users. Facebook status The status of a Facebook user, as presented to other users of Facebook on his Facebook page. GUI Graphical User Interface. Launcher An interface element to start an application or sub-application. Like Like is a way to give positive feedback or to connect with things on Facebook. ain-app(lication) The application that functions as a portal to the other sub-applications. ain menu ediawiki oow model News item Path POI R feed atellite (map) view ub-app(lication) tylistic (map) view TU/e Tweet Twitter page Topic UAR UOR URD User Vertex 1.4 List of references Part of the main-app in which the launchers are shown. ediawiki is a popular free web-based wiki software application. A wiki is a website that allows the creation and editing of any number of interlinked web pages via a web browser. A prioritization technique used in software development to reach a common understanding with the client on the importance they place on the delivery of each requirement. Item in one of the feeds regarding the TU/e news. A pair of geographical points, which are connected by a straight road. Point-of-Interest. An R feed is a data format used for providing users with frequently updated content (such as news and agenda information). A display of a map that consists of aerial photos. An application, which can only be started by using a launcher in the main-app. A display of a map that does not consist of photos, but of lines, boxes, etc. Eindhoven University of Technology. To post an update to a Twitter page. A page on the social network site twitter.com. Information on such a page consists of a list of so-called tweets. An example is the Twitter page of the TU/e ( Item regarding a subject inside the Encyclopedia or tudent Handbook. User apability Requirement. User onstraint Requirement. User Requirements Document. tudent who uses the system and has no rights to modify the app. Geographical point that is important in the navigation process. [1] E. TU/e corporate identity. Guidelines regarding layout and design. [2] EA Board for oftware tandardization and ontrol (B). European pace Agency oftware Engineering tandards. February

10 [3] Android UI team. Android guidelines. Guidelines regarding the User Interface. [4] Twitter Development team. Twitter guidelines. Guidelines regarding the layout of a tweet. 1.5 Overview The remainder of this document discusses user requirements in general in chapter 2 and in full detail in chapter 3. 7

11 hapter 2 General description 2.1 Product perspective Within the TU/e there are many information systems. For students that have just arrived here, especially foreign students, it is not clear where they can find information about certain facilities. Group ineption will develop an application that will help guide students on the campus. The application will use various information systems already available and add new functionality. Another requirement is that the application should be adaptable and easy maintainable. 2.2 General capabilities insapption will have the capabilities described below in order to provide students an easy overview of the campus and its facilities ain application The main application is a portal to all the other separate sub-application (sub-apps) which will provide the specific functionality, described in the following paragraphs. o called sub-applications will have no interaction, not counting some minor exceptions. The subapplications that are present in this main application should be maintainable, meaning new ones can be added and existing ones can be modified or deleted easily by a qualified software maintainer. Furthermore the main language of the application will be English, (only) in the main application the language can be changed to Dutch and the other way around. ub-applications will be shown depending on availability in the selected language ap This sub-application provides a navigational assistance on the TU/e campus (+ the train station). Users should be able to search for a certain point of interest and navigate from a specific location to another location. Locations can be entered in a text field and resolved to a certain building plus (if applicable) the floor and room number. Locations can also be selected on the map. The map sub-application should provide a map view containing a map of the campus on which the current position, buildings(and information about them),the planned route and the searched locations are shown. 8

12 2.2.3 Agenda The agenda shows all upcoming events regarding the TU/e, as provided in various R-feeds. The events should be presented in a calendar form and should be searchable News The news application shows all news items regarding the TU/e, as provided in a R-feed Encyclopedia This sub-application provides an Android specific front-end for the encyclopedia of the TU/e that is available as a ediawiki. This includes a search functionality and a main-screen. The encyclopedia sub-application is only available in the Dutch language Handbook This sub-application enables students to read the student handbook. Users can also open links mentioned in the handbook. The handbook application is only available in the Dutch language Facebook The Facebook application directs students to the Facebook page of the TU/e. The Facebook pages are not necessarily written in one language. The TU/e page contains information both in English and Dutch, hence we will present the same page for both selectable languages. Furthermore the users are able to view other Facebook pages related to the university Twitter The Twitter application directs the students to the Twitter page of the TU/e. The Twitter page is shown in the selected language. Furthermore the users are able to view other Twitter pages related to the university Employee finder In this application it is possible to search personnel on the university. Information available from the university servers about the searched person will be shown Additional social media requirements It is possible to tweet about a certain subject inside the application. Furthermore it is possible to use Facebook functionality meaning like and share Extendability insapption will be extendable. This means that a skilled Java Android programmer should be able to easily add a new sub-application to insapption, and add a launcher to it in the main-application. 9

13 aintainability insapption will be easy to maintain. Application maintainers should be able to maintain the application, without having knowledge about Java Android programming. They should be able to modify the approximate appearance of the application. This means the colors, and GUI figures in the applications, but not the addition/deletion of GUI elements. This can only be done achieved by adding a complete new sub-application to insapption (ee ). The application maintainer should also be able to change the (lists of) information sources of the sub-applications: agenda, news, Facebook and Twitter (more on this in the section 3). The application maintainer should also be able to add/delete/modify the data used in the map-application. 2.3 General constraints ome sub-applications rely heavily on specific services provided by third parties (employee database, R-feeds, ediawiki of encyclopedia), hence our means to search data are limited and the external data cannot be modified. Furthermore group ineption is bound by several guidelines (Twitter, Facebook, Android, corporate identity [1], etc.). First-time users should not have any difficulty getting familiar with insapption and further use should not cause any difficulties either. 2.4 User characteristics There are two types of users that interact with the final product tudents This is the main target group of our application. They should be able to use the application without any problems and without any knowledge about the program. tudents should only be able to (anonymously) retrieve information from the application, except for the social network functionalities (Twittering and using Facebook). For these social network functionalities the user must have an already created Twitter and Facebook account. The application will have the option to store the username and password for these accounts in order to prevent the user from entering them every time they tweet or use Facebook Application maintainers The application maintainers (administrators) will maintain the application, but are assumed to have no knowledge about Java Android programming. These users might have to interact with insapption in a different way from the students. The interaction may consist of editing files on a server, running a different special designed (by insapption) edit application to edit remote files. 10

14 2.5 Environment description Other systems in the environment insapption must interface with several other systems. R-feeds, the web-version of the TU/e Encyclopedia, Facebook, Twitter, Google and the employee-pages database of the university are existing systems insapption is planned to interact with or make use of. A graphical representation of the environment of insapption is shown in figure??. R-feeds The primary goal of this system is to provide the news application and the agenda application with information. The interaction with the R-feeds is one-way. The application will retrieve information via the internet and process it locally in order to display it in the two sub-apps. The most important R-feeds are the news feed and the agenda feed of the new TU/e site. TU/e Encyclopedia This system will provide the information shown in the encyclopedia application. The interaction with this system will consist for sending queries to the ediawiki of this encyclopedia and receiving the resulting information via the internet. Facebook This system has its own API and for performing like and other actions. Besides that the application can show the mobile site of Facebook. Twitter This system has its own API and for performing tweet and other actions. Besides that the application can show the mobile site of Twitter. Employee-pages database This system will provide the information shown in the employee finder application. The interaction with this system will consist of sending queries to the employee pages server and receiving the resulting information via the internet. Google This system will provide insapption with their satellite images of the campus Platform The application that students use will run on smart phones (with the operating system Android 2.3). The application maintainer will use a computer. 2.6 Assumptions and dependencies The application needs internet access. A webserver is available for insapption to store data on (done by application maintainer) and retrieve data from (done by the students). 11

15 The agenda R-feed has a certain fixed format from which the date of an event can be parsed. The student handbook will be available in a format that is searchable and that is split into hierarchical sections, however the links may be outdated. The ediawiki will not change. The API of Facebook will not change. The API of Twitter will not change. The access methods of the employee-pages database will not change. The TU/e Encyclopedia is available in the ediawiki format. The design guidelines of Twitter, Facebook, Google and Android overrule the guidelines of the corporate identity [1] in conflicting situations. 12

16 hapter 3 pecific requirements The specific requirements discussed in this section are divided into logical subsections. For prioritizing the specific requirements for insapption, we will adhere to the oow model. The capital letters in oow stand for: ust have; these requirements are essential for the product. hould have; these requirements are not critical for the product to work, but are nearly as important as the must haves, meaning they must be implemented if at all possible. ould have; requirements which are not critical to the product s success. If they can be implemented with little development costs, they can increase customer satisfaction. W Would have; these requirements will not be implemented in this project. However, they would be nice to have in future versions of the product. The priority for each requirement is mentioned with the respective requirement. 3.1 apability requirements General Language UAR001 All text elements in the user interfaces are presented in the selected language (for language selection see requirement UAR101. The available languages are mentioned in UAR002 and UAR003). UAR002 English is an available language. UAR003 Dutch is an available language. Program adaptability UAR004 ub-apps and their launchers can be added to the main app by a qualified programmer. UAR005 ub-apps and their launchers in the main app can be deleted by a qualified programmer. 13

17 aintenance of user interface UAR006 The administrator can change the colors used in the user interfaces of the sub-apps and main-app (this does not include the external resources). UAR007 The administrator can change the fonts used in the user interfaces of the sub-apps and main-app (this does not include the external resources). UAR008 The administrator can change icons used in the user interfaces of the sub-apps and main-app (this does not include the external resources). UAR009 The administrator can change buttons used in the user interfaces of the sub-apps and main-app (this does not include the external resources). UAR010 The administrator can change the background used in the user interfaces of the subapps and main-app (this does not include the external resources). UAR011 The administrator can change text elements used in the user interfaces of the sub-apps and main-app (this does not include the external resources) ain app UAR101 The language can only be selected in the main app. UAR102 The default language of insapption is English UAR103 The main menu contains a launcher to the ap-app UAR104 The main menu contains a launcher to the News-app UAR105 The main menu contains a launcher to the Agenda-app UAR106 The main menu contains a launcher to the Facebook-app UAR107 The main menu contains a launcher to the Twitter-app UAR108 The main menu contains a launcher to the Employee-finder-app UAR109 The main menu contains a launcher to the Encyclopedia-app, only if the Dutch language is selected UAR110 The main menu contains a launcher to the tudent handbook-app, only if the Dutch language is selected UAR111 It is possible to like insapption from within the main menu. 14

18 UAR112 It is possible to tweet insapption from within the main menu. UAR113 There is a link to a Twitter settings menu. UAR114 There is a link to a Facebook settings menu. UAR115 In the settings menu for Twitter the user can save username in combination with password, regarding Twitter. UAR116 In the settings menu for Facebook the user can save username in combination with password, regarding Facebook. UAR117 In the settings menu for Twitter there is an option to delete the saved username in combination with the password, regarding Twitter. UAR118 In the settings menu for Facebook there is an option to delete the saved username in combination with the password, regarding Facebook. UAR119 The application maintainer can modify the appearance of the separate launchers ap-app UAR201 It is possible to search for a certain building on the campus of the TU/e by name. UAR202 It is possible to search for a certain building on the campus of the TU/e by address. UAR203 It is possible to search for a certain POI on the campus of the TU/e by name. UAR204 A search described in requirements UAR201 and UAR202 results in a displayed set of buildings that match the search input. UAR205 A search described in requirements UAR203 results in a displayed set of POI s that match the search input. UAR206 It is possible to view an element from the search result described in UAR201, UAR202 and UAR203 in the map view. UAR207 It is possible to navigate from a building on the campus to another building on the campus. UAR208 It is possible to navigate from a building on the campus to a POI on the campus. UAR209 It is possible to navigate from a POI on the campus to a building on the campus. UAR210 It is possible to navigate from a POI on the campus to a POI on the campus. 15

19 UAR211 It is possible to navigate from an POI on the campus to another location on the campus. UAR212 It is possible to navigate from a street on the campus to another location on the campus. UAR213 It is possible to switch between different means of transportation in the navigator. UAR214 The from-location can be searched by the name of a building. UAR215 The from-location can be searched by the address of a building. UAR216 The from-location can be searched by the name of a POI. UAR217 The from-location is selected from the search result described in UAR211 and UAR212. UAR218 The from-location can be selected on the map. UAR219 The to-location can be searched by the name of a building. UAR220 The to-location can be searched by the address of a building. UAR221 The to-location can be searched by the name of a POI. UAR222 The to-location is selected from the search result described in UAR215 and UAR216. UAR223 The to-location can be selected on the map. UAR224 The route planned by the navigator is shown in the map view. UAR225 The application has a map view in stylistic style. UAR226 The application has a map view in satellite style. UAR227 It is possible to switch between stylistic map view and satellite map view. UAR228 It is possible to zoom when in the map view. UAR229 It is possible to pan when in the map view. UAR230 urrent location is shown in the map view. UAR231 POI s of a building are indicated. W 16

20 UAR232 It is possible to tweet the user s current location. UAR233 It is possible to change the status on Facebook. The new status will indicate the user s current location. UAR234 The administrator can change the stylistic map. UAR235 The administrator can add buildings. UAR236 The administrator can remove buildings. UAR237 The administrator can add vertices of a path which is used in the route planner. UAR238 The administrator can remove vertices of a path which is used in the route planner. UAR239 The administrator can remove edges of a path which is used in the route planner. UAR240 The administrator can add edges of a path which is used in the route planner. UAR241 The administrator can add POI s. A POI should belong to a certain building, floor and room number. UAR242 The administrator can remove POI s. A POI should belong to a certain building, floor and room number. UAR243 The administrator can link a POI to a certain building, floor and room. UAR244 The administrator can unlink a POI from a certain building, floor and room News-app UAR301 Titles of all news items available through the news R-feeds are shown on the title screen. UAR302 From the first titles of the news articles, the first lines are shown. UAR303 Full news report is shown after choosing the corresponding news title. UAR304 It is possible to like a certain news item. UAR305 It is possible to tweet a certain news item. UAR306 The administrator can modify the list of news R-feeds that are available in English. UAR307 The administrator can modify the list of news R-feeds that are available in Dutch. 17

21 3.1.5 Agenda-app UAR401 When the agenda-app is started, upcoming events are shown on the title screen. UAR402 There is a calender view. UAR403 It is possible to open calendar view. UAR404 It is possible to close calendar view. UAR405 The user can change the calender to a different month. UAR406 The user is able to see on which days events take place in calendar view. UAR407 The current day is indicated on the calendar. UAR408 By selecting a certain day in the calendar the events for that day are shown. UAR409 It is possible to search for events by date. UAR410 It is possible to search for events by subject. UAR411 A search described in requirements UAR406 and UAR407 results in a displayed set of events that match the search input. UAR412 It is possible to like a certain event. UAR413 It is possible to tweet a certain event. UAR414 The only events that are available in the agenda-app are extracted from the agenda R-feeds in the selected language. UAR415 The administrator can modify the list of agenda R-feeds that are available in English. UAR416 The administrator can modify the list of agenda R-feeds that are available in Dutch. 18

22 3.1.6 Employee-finder-app UAR501 It is possible to search a person by name. UAR502 It is possible to search a person by department. UAR503 A search described in requirements UAR501 and UAR502 results in a displayed set of employees that match the search input. UAR504 It is possible to view all personal info available through the employee pages of a person in the search result set of requirement UAR503. UAR505 It is possible to show the location of the employee s office in the map view (see 3.1.3). UAR506 It is possible to plan a route to the location of the employee s office (see 3.1.3) Encyclopedia-app UAR601 When the Encyclopedia-app is started the most searched items are shown on the title screen. UAR602 When the Encyclopedia-app is started the most recent items are shown on the title screen. UAR603 It is possible to search the book by a certain word or phrase. UAR604 A search described in requirement UAR602 results in a displayed set of topics. UAR605 The user can select a topic from the search result list. UAR606 By clicking on a topic the full text regarding that topic is shown. UAR607 It is possible to like a certain topic. UAR608 It is possible to tweet a certain topic. 19

23 3.1.8 tudent handbook-app UAR701 When the student handbook-app is started the most searched items are shown on the title screen. UAR702 It is possible to search the book by a certain word or phrase. UAR703 A search described in requirement UAR702 results in a displayed set of topics. UAR704 The user can select a topic from the search result described in requirement UAR703. UAR705 By clicking on a topic the full text regarding that topic is shown. UAR706 It is possible to like a certain topic. UAR707 It is possible to tweet a certain topic Facebook-app UAR801 When the Facebook-app is started the page of TU/e on Facebook is shown on the title screen. UAR802 Other TU/e related Facebook-sites can be selected from a list (see for contents of list requirement UAR803). UAR803 The administrator can modify the list of TU/e related Facebook-sites Twitter-app UAR901 When the Twitter-app is started the page of TU/e on Twitter is shown on the title screen. UAR902 Other TU/e related Twitter-sites can be selected from a list (see for contents of list requirement UAR903). UAR903 The administrator can modify the list of TU/e related Twitter-sites. 20

24 3.2 onstraint requirements General UOR001 The app runs on a smart phone with operating system Android version 2.3. UOR002 All layout shall be according to the TU/e corporate identity [1], unless in conflict with the guidelines of requirements UOR003-UOR006. UOR003 Icons are according to the Android Icon Guidelines.[3] UOR004 The user interfaces should be according to the Android User Interface Guidelines.[3] UOR005 The Twitter tweet interface should be according to the Twitter Guidelines.[4] UOR006 The Facebook like interface should be according to the Facebook Guidelines ap-app UOR201 The campus map covers the campus of the TU/e. UOR201 The campus map covers the central train station of Eindhoven. UOR202 A new stylistic map has the right dimensions. UOR202 A new stylistic map is geographically correct News-app UOR301 News is restricted to what is available in the feeds on the list of news R-feeds Agenda-app UOR401 Agenda is restricted to what is available in the feeds on the list of agenda R-feeds Person-finder-app UOR501 Information about a certain person is restricted to what is available on the employee pages of the TU/e Encyclopedia-app UOR601 The information and the search methods of the Encyclopedia-app are restricted to the services provided by the ediawiki of the TU/e Encyclopedia. 21

25 3.2.7 tudenthandbook-app UOR701 The information and the search methods of the tudenthandbook-app are restricted depending on file format of the handbook-information. 22