Skip to content

Req v1.0 Headings

Halil Umut Özdemir edited this page Feb 29, 2020 · 5 revisions

Glossary

1. User: a registered person who uses the application

2. Guest: an unregistered person who uses the application

3. Admin: a user who is capable of managing the whole application.

4. Research Paper: a document which contains information about user's research

5. Tags of contents: A label attached to someone or something for the identification or to give other information.

6. Recommendation System: A subclass of an information filtering system that seeks to predict the preferences and interests of a person.

7. Search Engine: A tool that enables users to locate information in the application or web.

8. API: A set of routines, protocols, and tools for building software applications.

9. Terms of Use: The legal agreements between a service provider and a person who wants to use that service.

10. Privacy Policy: A statement or a legal document (in privacy law) that discloses some or all of the ways a party gathers, uses, discloses, and manages a customer or client's data.

11. Workspace: A storage area for a group of users to develop their project/paper proposal collaboratively.

12. Deadline and Milestone Mechanism: A mechanism to add deadlines for some tasks of the projects on a timeline.


1. Functional Requirements

1.1 User Requirements

1.1.1 Guests

1.1.2. Registration & Login

  • 1.1.2.1uA user shall provide his/her full name while registering.
  • 1.1.2.2 A user shall provide a unique email address while registering.
  • 1.1.2.3 A user shall provide a password while registering.
  • 1.1.2.4 A user shall provide his/her institutions while registering.
  • 1.1.2.6 A user should provide his/her expertise while registering.
  • 1.1.2.7 A registered user shall be able to login by providing his/her e-mail and password.
  • 1.1.2.8 A User shall be able to register by using his/her Google account.

1.1.3. User Follow System

  • 1.1.3.1 A registered user shall be able to follow other registered users.

  • 1.1.3.2 A registered user shall be able to comment on other users if they worked together with.

1.1.4. Permissions in Projects

  • 1.1.4.1 A registered user shall be able to create a project/paper proposal workspace.
  • 1.1.4.2 A registered user shall be able to invite other users and create a team.
  • 1.1.4.3 A registered user shall be able to create public and private projects/paper proposals.
  • 1.1.4.5 A registered user shall be able to set a deadline for the submission of a task.
  • 1.1.4.6 A registered user shall be able to specify the requirements of his/her project.
  • 1.1.4.7 A registered user shall be able to upload the codes, documents, plots, images about his/her project or paper proposal workspace.
  • 1.1.4.8 A user shall be able to see the contents of the public workspaces when the project is in the published state.
  • 1.1.4.9 A registered user and his/her team for a project shall be able to see the contents of this private workspace.

1.1.5. Profile Page

  • 1.1.5.1 A registered user shall be able to link his/her other related accounts.

1.1.6. Search

1.2. System Requirements

1.2.1. Upcoming Events

  • 1.2.1.1 The system shall provide a calendar that shows upcoming events.

1.2.2. Home Page

1.2.3. Search Engine

  • 1.2.3.1 The platform shall support a search engine which can use a set of basic keywords.
  • 1.2.3.2 Search engine shall search content concerning the research area, topic, scope, and difficulty.
  • 1.2.3.3 Search engine shall provide the recent searches of a registered user.

1.2.4. Recommendation

  • 1.2.4.1 The platform shall provide a history section to keep user activity.
  • 1.2.4.2 The platform shall provide labels according to the user's skills.
  • 1.2.4.3 The platform shall support a recommendation system.
  • 1.2.4.4 The recommendation system shall work according to the old project or paper preferences of the user.

1.2.5. Notification

1.2.6. Project/Issue Management System

  • 1.2.6.1 The platform shall provide a deadline and milestone mechanism for project management.
  • 1.2.6.2 A project's milestones throughout the collaboration should exist, be shared and monitored.
  • 1.2.6.3 A project's submission document should exist, be shared and monitored.
  • 1.2.6.4 A project's codes should exist, be shared and monitored.
  • 1.2.6.5 A project's related materials should be shared and monitored.

1.2.7. Profile Page

  • 1.2.7.1 The system shall provide a profile page for all registered users.
  • 1.2.7.2 The profile page shall provide information about the research area.
  • 1.2.7.3 The profile page shall provide information about recent publications.
  • 1.2.7.4 The profile page shall provide information about affiliation.
  • 1.2.7.5 The profile page should be fetched from the users' accounts of other related sites.
  • 1.2.7.6 The profile page should have a comments and rating section.

2. Non-Functional Requirements

2.1. Performance

2.2. Security

2.3. Portability

2.4. Ethical Issues and Legal Constraints

  • 2.4.1 In this application "personal information", "contact information", "copyrighted contents", etc. shall be used according to the rules of GDPR and KVKK.

  • 2.4.2 In this project, ethical constraints shall be complied according to ACM Code of Ethics and Professional Conduct document.

  • 2.4.3 New users should accept the "Terms of Use" and "Privacy Policy" of the platform which are prepared according to relevant regulations.

2.5. Implementation

  • 2.5.1 The application shall be deployable on a remote and manually configurable remote server.

  • 2.5.2 The application should be dockerized.

  • 2.5.2 The application shall include necessary API implementations.

  • 2.5.3 Both web platform and Android application should be user-friendly.

  • 2.5.4 There shall be a web platform and a native Android application that supports the same functionalities.

References :









Clone this wiki locally