From d26145297035c36fe77e2537f89cfab5d73cab83 Mon Sep 17 00:00:00 2001 From: Sagi Dayan Date: Tue, 21 Apr 2015 19:16:55 +0300 Subject: [PATCH] Created SRS (markdown) --- SRS.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 SRS.md diff --git a/SRS.md b/SRS.md new file mode 100644 index 0000000..b79a51d --- /dev/null +++ b/SRS.md @@ -0,0 +1,69 @@ +SE Hub - SRS + +1. **Introduction** + + 1.1 **Goal** + + * ***The product:*** "SE Hub" will help Lecturers and Students to manage, communicate and follow the **S**oftware **E**ngineering course schedule. + + * ***The development environment***: JCE (Jerusalem College of Engineering) + + * "SE Hub" will improve the unorganized and fragmented resources that lecturers and students use. + + * "SE Hub" aims to HELP and nothing more + + * "SE Hub" Will offer an easy to use UI with the power of the modern web platforms. + + * Our client: For now - Our Lecturer (Software engineering course JCE 2015) and some of Our class mates + + 1.2 **Scope** + + "SE Hub" will bring to the table a simple way to manage the course. + The main idea is to unify all services the we use today: + - Github + - School website + - Google docs + - Dropbox / google drive / one drive etc... + + The Lecturer will have a Dashboard that will help him monitoring all class projects, while the Student will know exactly what is his next task due. + And much more... + + 1.3 **Terms** + - **Campus** - The name of the Academic institute. + in a Campus you will have *Courses*. i.e JCE (israel) + - **Course** - The name actual course i.e SE2015 + - **Lecturer** - Each Course needs to have at least one *Lecturer*. he +is the "Course" Manager" + - **Student** - We all know right? + - **Project** - A GitHub Repository associated with the *Students* *Course* Project + + 1.4 **Review** + + The rest of this document will discuss the possible use cases that this product might face. + We will Show both the Lecturer & Student side of things + +2. **Use Cases** + + //TODO + +3. **User Stories** + + //TODO + + +4. **Environmental requirements** + + 4.1 **Hardware requirements**: + + The software requires a computer and an Internet connection works. + + 4.2 **Software requirements**: + + "SE Hub" Depends on the GitHub API for developers. + therefore, Users need to have a GitHub Account. + + +5. **Mockup**: + +//TODO +