Requirements

Glossary

• 1 Cultural Heritage Item: An item with description that somewhat connected to culture and heritage.
• 2 Annotations: Any further info regarding an any cultural heritage item as elaboration, translation, meta in- formation, question, and answer.
• 3 Tag: predefined words that helps categorize and search heritage items and searches.
• 4 Meta Information: Informations that defines the cultural heritage item as title, geo-tag tag, creator and so forth.
• 5 User:
  • 5.1 Guest user: Any user that visits the web-site without any registration who can view but not edit any heritage items ,annotations and comments.
  • 5.2 Registered User: Users that passed the log-in process and can edit or create annotation and heritage items and commends in addition to guest user privileges.
• 6 Score: Difference between the number of up-votes and down-votes of a heritage item.

1.Functional

1.1 Users

• 1.1.1 Guest Users
  • 1.1.1.1 Guest users shall be able to search for heritage items.
  • 1.1.1.2 Guest users shall be able to register and become a registered user.
    • 1.1.1.2.1 Guest users shall be able to register via their email address and a username.
  • 1.1.1.3 Guest users shall be able to view the content of a cultural heritage item.
• 1.1.2 Registered Users
  • 1.1.2.1 Registered users shall be able to create cultural heritage items.
  • 1.1.2.2 Registered users shall be able to create annotations.
  • 1.1.2.3 Registered users shall be able to edit and delete the cultural heritage items and annotations that they have created.
  • 1.1.2.4 Registered users shall be able to search for cultural heritage items.
  • 1.1.2.5 Registered users shall be able to update their profile.
    • 1.1.2.5.1 Registered users shall be able to change their password.
    • 1.1.2.5.2 Registered users shall be able to change their email address.
  • 1.1.2.6 Registered users shall be log in with their username and password.
  • 1.1.2.7 Registered users can comment to heritage items.
  • 1.1.2.8 Registered users can comment to previous comments.
  • 1.1.2.9 Registered users can upvote and downvote heritage items.
  • 1.1.2.10 Registered users shall be able to view the content of a cultural heritage item.

1.2.Heritage Items

• 1.2.1 Heritage items shall have a description.
• 1.2.2 Heritage items shall have meta information.
  • 1.2.2.1 Heritage items shall have creation date of the heritage item object.
  • 1.2.2.2 Heritage items shall support a date representation of the time that heritage item actually came into existence.
    • 1.2.2.2.1 It can be an exact date.
    • 1.2.2.2.2 It can be duration between two dates.
  • 1.2.2.3 Heritage items shall have a title.
  • 1.2.2.4 Heritage items can have geo-tag.
  • 1.2.2.5 Heritage items can have semantic tags.
• 1.2.3 Heritage items shall support media representations.
  • 1.2.3.1 The system shall support voice records.
  • 1.2.3.2 The system shall support pictures.
  • 1.2.3.3 The system shall support voice videos.
  • 1.2.3.4 The system shall support text records.
  • 1.2.3.5 Heritage items`s media representations shall be able to exist in our platform.
  • 1.2.3.6 Heritage items`s media representations shall be able to exist in other platforms if the user has permission to share.
• 1.2.4 Heritage items shall have a search procedure
  • 1.2.4.1 All users shall be able to search for cultural heritage items.
  • 1.2.4.2 Users shall be able to search using the heritage items' name, creator, location, date or semantic tags.
  • 1.2.4.3 Search results shall be sorted according to the specified filter.
    • 1.2.4.3.1 Specified filter can be creation date, score, or further specifications in 1.2.4.2
• 1.2.5 Each heritage item can be up-voted or down-voted by any registered user.

1.3 Annotations

• 1.3.1 A registered user shall be able to annotate cultural heritage item for elaboration, translation and meta information of that item.
• 1.3.2 A registered user shall be able to comment on an existing cultural heritage item for asking and answering questions.
• 1.3.3 Annotations can be in text format on any type of heritage item.
• 1.3.4 A web browser plugin (Firefox) that enables users to create and visualize annotations for cultural heritage must be provided

1.4 Comments

• 1.4.1 Registered users shall be able to commit comments.
  • 1.4.1.1 Registered users shall comment on cultural heritage items.
  • 1.4.1.2 Registered users shall comment on other comments.
• 1.4.2 All users shall be able to read comments.
• 1.4.3 Registered users shall be able to delete their own comments.

1.5 Upvoting/Downvoting System

• 1.5.1 Each heritage items can be upvoted or downvoted and by only registered users.
• 1.5.2 Each heritage items can be upvoted or downvoted by only registered users only once.

1.6 Recommendation System and Popular Post Feed

There is gonna be 4 type of system offered suggestions for users

• 1.6.1 There is gonna be popular heritage items which is same for every users.
  • 1.6.1.1 Heritage items are gonna be ordered by the creation date.
  • 1.6.1.2 Heritage items that have bigger score than a threshold will be picked.
    • 1.6.1.2.1 Threshold will be defined dynamically depending on the number of daily voting activity letting certain number of Heritage items pass the threshold for a day.
• 1.6.2 There is gonna be recommended heritage items for each registered user.
  • 1.6.2.1 Heritage items that have similar tags to the previously up-voted heritage items by the user shall be recommended to the user, if it is not seen yet.
  • 1.6.2.2 Heritage items that have similar tags to the previously down-voted heritage items by the user shall not be recommended to the user.
• 1.6.3 There is gonna be system recommended heritage items specific to the heritage item registered user is displaying.
  • 1.6.3.1 The recommendations will be consist of similar heritage items to the currently displaying heritage item.
  • 1.6.3.2 The recommendation will be consist of heritage items with tags like previously up-voted heritage items` tags.
• 1.6.4 There is a also gonna be a fresh section in recommendation system, which will contain most recent heritage item depending on its creation date(1.2.2.1) and is same for all users.

2. Non-Functional

2.1 Language

• 2.1.1 Language of the web site shall be English.
• 2.1.2 Language of annotations and heritage items shall be in any language.

2.2 Performance

• 2.2.1 No search request should last longer than a second.
  • 2.2.1.1 The system shall respond to requests within 1 second.

2.3 Availability

• 2.3.1 The system shall be available to users 99% of the time.
• 2.3.2 In the event of a failure, the system shall be up within 2 hours.

2.4 Portability

• 2.4.1 The system shall have both Android application and Web version.
• 2.4.2 The users shall be able to enter the system from a smart phone, tablet or pc.
• 2.4.3 The Website should support most recent versions of Google Chrome, Mozilla Firefox, Opera, Internet Explorer, Safari browsers.

2.5 Security

• 2.5.1 All passwords stored in the database must be encrypted.

2.6 Privacy

• 2.6.1 User's informations(password, location etc.) shall not be shared with any other applications.

2.7 Protocols and Models

• 2.7.1 To annotate heritage items W3C Web Annotation Data Model proposed recommendation shall be used.
• 2.7.2 To store and retrieve annotations Web Annotation Protocol shall be used.
• 2.7.3 JSON-LD should be used for annotation representation as described in the W3C documentation.

2.8 Plug-in Requirements

• 2.8.1 Web browser plugin shall enable users to create and visualize annotations.