Skip to content
Muhammed Enes Toptaş edited this page Mar 9, 2020 · 29 revisions

Glossary

  • 1. User: A person capable of contributing to or collaborating with others Projects/Papers, and has their own profile page. Authentication is required. There are 2 types of users, personal and corporal(institutional).
  • 2. Collaborator: A user that participates a project/paper.
  • 3. Profile Page: Page that users shall be able to share information about themselves.
  • 4. Events: The news about upcoming conferences, meetings and important dates.
  • 5. Guest: The user who is able to view Projects/Papers and see people's profile pages. No Authentication is required.
  • 6. Profile: A visual display of personal data associated with a specific user.
  • 7. Search: Find semantically similar users and Projects/Papers on the context information provided in the semantic tags.
  • 8. Password: Consists of at least six characters (the more the merrier) that are a combination of letters and numbers.
  • 9. Projects: Long-term works that involve milestones, business packages, deadlines.
  • 10. Papers: Short-term works that contain original research results or review existing results or show a totally new invention.
  • 11. Basic Search: Only text matching based search.
  • 12. Tag: Small labels that indicates related aspects of an project/paper.
  • 13. Report System: System that allows users to report problematic cases.
  • 14. Notification: Message that informs the user about a specific event.
  • 15. Recommendation System: System that recommends contents, papers, and project that user might interested in.

Project Requirements


1. Functional Requirements

  • 1.1 User Requirements

    • 1.1.1 Users shall be able to search and see public papers or projects

    • 1.1.2 Users shall be able to see profile pages of authors, and collaborators of papers and projects

    • 1.1.3 Users shall be able to search related information about the upcoming conferences or journal special issues

    • 1.1.4 Guests

      • 1.1.4.1 Guests shall be able to search and see private papers or projects but shall not be able to see their content
      • 1.1.4.2 Guests shall not be able to join papers/projects, comment to papers/projects or post new papers/projects.
      • 1.1.4.3 Registration
        • 1.1.4.3.1 Guests shall be able to register
        • 1.1.4.3.2 To register, guest user shall provide name, surname, email and password
        • 1.1.4.3.3 User shall validate account via e-mail.
        • 1.1.4.3.4 Users who are academicians shall provide the name of the university/institution they're working at and the academic area they're studying they shall also upload two photos of themselves
        • 1.1.4.3.5 Users who are academicians shall provide id/social security number.
    • 1.1.5 Registered Users

      • 1.1.5.1 User shall login by email and password provided
      • 1.1.5.2 User shall be able to state whether s/he is looking for a project to collaborate
      • 1.1.5.3 User shall be able to send request to join the team
      • 1.1.5.4 User shall be able to accept or reject requests to join the team
      • 1.1.5.5 User shall be able to invite any academicians to participate
      • 1.1.5.6 User shall be able to rate and comment other users that s/he collaborated with after the project completed
      • 1.1.5.7 User shall be able to make comments on his/her profile page private
      • 1.1.5.8 User shall be able to collaborate on more than one paper/project
      • 1.1.5.9 If user is not taking collaborators anymore s/he shall state that
      • 1.1.5.10 User shall be able to have more than one paper/project topic posted
      • 1.1.5.11 User shall be able to specify a deadline or make the deadline open for the paper/project
      • 1.1.5.12 User shall not be able to delete a paper/project that is in progress
      • 1.1.5.13 User shall be able to file complaints
        • 1.1.5.13.1 User shall be able to report another user, a project or a paper for unwanted/inappropriate behavior
        • 1.1.5.13.2 User shall be able to mark a publication as unrelated
      • 1.1.5.14 User shall be able to follow other users on the platform.
        • 1.1.5.14.1 User shall be able to approve/reject follow requests.
        • 1.1.5.14.2 User shall be able to set visibility of their projects/papers for the users not following them.
        • 1.1.5.14.3 User shall be able to request to join a project/paper if they can see it.
        • 1.1.5.14.4 User shall be able to invite other uses to collaborate, without following them.
      • 1.1.5.15 User shall be able to set their profiles to public or private.
    • 1.1.6 Profile Page

      • 1.1.6.1 Users shall provide information about:
        • 1.1.6.1.1 The research area
        • 1.1.6.1.2 Recent publications
        • 1.1.6.1.3 Affiliation
      • 1.1.6.2 Users shall be able to link their Google Scholar or ResearchGate accounts.
      • 1.1.6.3 Users shall be able to edit their own profile page.
      • 1.1.6.4 Users shall be able to see invitations that are sent from the other users.
      • 1.1.6.5 Users shall be able to see messages that are sent from the other users.
      • 1.1.6.6 Users shall be able to see ratings and comments that are made by other users.
    • 1.1.7 Creating / Editing Page

      • 1.1.7.1 Users shall be able to share information about:
        • 1.1.7.1.1 Topic of the research
        • 1.1.7.1.2 Deadline of submission
        • 1.1.7.1.3 Milestones
        • 1.1.7.1.4 Codes
        • 1.1.7.1.5 Documents
        • 1.1.7.1.6 Result plots / figures
        • 1.1.7.1.7 Required skills in order to apply.
        • 1.1.7.1.8 If the project is funded or not.
      • 1.1.7.2 User shall be able to add a summary part.
      • 1.1.7.3 User shall be able to state the type of the content (Paper or Project).
      • 1.1.7.4 User shall be able to state whether project/paper is private or public.
      • 1.1.7.5 User shall be able to add co-authors and collaborators during creation of a project.
      • 1.1.7.6 User shall be able to add tags related to project/paper.
      • 1.1.7.7 Collaborators shall be able to track the information shared by corresponding user.
      • 1.1.7.8 Collaborators shall be able to prepare document or article for submission simultaneously.
    • 1.1.8 Search Page

      • 1.1.8.1 Users shall be able to search:
        • 1.1.8.1.1 Other users
        • 1.1.8.1.2 Papers
        • 1.1.8.1.3 Projects
        • 1.1.8.1.4 Conferences
        • 1.1.8.1.5 Journals
        • 1.1.8.2 Users shall be able to filter contents according to:
        • 1.1.8.2.1 Research area
        • 1.1.8.2.2 Topic
        • 1.1.8.2.3 Scope
        • 1.1.8.2.4 Difficulty
        • 1.1.8.3 Users shall be able to find related posts searching related keywords.
        • 1.1.8.4 Users shall be able to see papers/journals/projects/conferences.
    • 1.1.9 Paper/Project Page

      • 1.1.9.1 Users shall be able to create a new paper.
      • 1.1.9.2 Users shall be able to create a new project.
      • 1.1.9.3 Users shall be able to see the status of his/her paper(s).
      • 1.1.9.4 Users shall be able to see the status of his/her project(s).
      • 1.1.9.5 Users shall be able to edit the specifications of his/her paper(s).
      • 1.1.9.6 Users shall be able to edit the specifications of his/her project(s).
      • 1.1.9.7 Users shall be able to see his/her paper(s) in progress.
      • 1.1.9.8 Users shall be able to see his/her project(s) in progress.
      • 1.1.9.9 Users shall be able to edit the specifications of his/her paper(s) in progress.
      • 1.1.9.10 Users shall be able to edit the specifications of his/her project(s) in progress.
      • 1.1.9.11 Users shall be able to invite another registered user to collaborate on his/her paper(s) in progress.
      • 1.1.9.12 Users shall be able to invite another registered user to collaborate on his/her project(s) in progress.
    • 1.1.10 Events Page

      • 1.1.10.1 Users shall be able to see about upcoming conferences related to joined projects/papers.
      • 1.1.10.2 Users shall be able to see closing deadlines of joined projects/papers.
      • 1.1.10.3 Users shall be able to travel in the timeline to see past events.
      • 1.1.10.4 Users shall be able to travel in the timeline to see far future events.
      • 1.1.10.5 Users shall be able to synchronize this calendar with other calendar applications.
      • 1.1.10.6 Users shall be able to view particular event more detailed when clicked/tapped.
  • 1.2 System Requirements

    • 1.2.1 Search & Recommendation

      • 1.2.1.1 System shall support basic search of the available content.
      • 1.2.1.2 System shall support semantic search.
      • 1.2.1.3 System shall provide a tagging system.
      • 1.2.1.4 System shall provide a filtering system.
      • 1.2.1.5 System shall provide a recommendation system that recommends papers/journals/projects/conferences to the registered user based on the user activities and profile.
    • 1.2.2 Homepage

      • 1.2.2.1 System shall provide a homepage for each registered user according to the user's interests.
    • 1.2.3 Profile Page

      • 1.2.3.1 System shall provide a profile page for each registered user, showcasing their interests, past contributions to projects and papers, their contacts and their related links (example: Google Scholar).
      • 1.2.3.2 System shall retrieve information (example: citations, h-index) of a user from their Google Scholar/ResearchGate pages.
    • 1.2.4 Notifications

      • 1.2.4.1 System shall provide a notification system for registered user, with which user shall be able to see invitations
      • 1.2.4.2 System shall provide a notification system for registered user, with which user shall be able to his/her request to join a team accepted or rejected
      • 1.2.4.3 System shall provide a notification system for registered user, with which user shall be able to see if someone is accepted his/her invitation
      • 1.2.4.4 System shall provide a notification system for registered user, with which user shall be able to see if someone is commented on his/her profile page
      • 1.2.4.5 If a user performs an unauthorized activity System shall warn user
    • 1.2.5 Notifications

      • 1.2.5.1 System shall provide a page of Events for every registered user.
      • 1.2.5.2 System shall fill this page with the events related to registered user.

2. Nonfunctional Requirements

🎓 Team Members

User Manuals

System Manuals

💻 Project

🗓 Meeting Notes 352

🗓 Meeting Notes 451

Milestones

📎 Assignments

🔍 Issue Labels

📞 Communication Plan

📝 Research

Project Plan

Brain Storms

Clone this wiki locally