Merge pull request #350 from tristyxxnana/adocUpdate

Adoc update

docs/DeveloperGuide.adoc

@@ -1863,14 +1863,10 @@ Use case resumes at step 1.
 === Use case: Add Gradebook Component
 *Precondition(s)* :
 
-* Module code must exist
-* Component name must not already exist in Trajectory.
+* Gradebook component name NOT exist in existing module.
 * Accumulated weightage for gradebook components in module cannot exceed 100%.
-* Weightage can be 0 for gradebook components like Mock Practical Exam.
 
-*Guarantees* :
-
-* Gradebook component will not be added if it does not meet validation requirements.
+*Guarantees* : NIL
 
 *MSS* :
 
@@ -1893,24 +1889,6 @@ Use case resumes at step 1.
 +
 Use case resumes at step 1.
 
-* 2c. Teacher enters a component name that already exists to module code.
-+
-** 2c1. System informs the user that component name already exists to module code.
-+
-Use case resumes at step 1.
-
-* 2d. Teacher enters a non-integer input for maximum marks and weightage.
-+
-** 2d1. System informs the user of incorrect input.
-+
-Use case resumes at step 1.
-
-* 2d. Teacher does not enter any inputs after prefix.
-+
-** 2d1. System informs the user of invalid input.
-+
-Use case resumes at step 1.
-
 
 [discrete]
 === Use case: Update Gradebook Component
@@ -1920,9 +1898,7 @@ Use case resumes at step 1.
 * Accumulated weightage including the updated weightage must not exceed 100%.
 * At least one optional parameter must be included in command.
 
-*Guarantees* :
-
-* NIL
+*Guarantees* : NIL
 
 *MSS* :
 
@@ -1975,9 +1951,7 @@ Use case resumes at step 1.
 
 * Gradebook component name must exist in existing module.
 
-*Guarantees* :
-
-* NIL
+*Guarantees* : NIL
 
 *MSS* :
 
@@ -2006,9 +1980,7 @@ Use case resumes at step 1.
 
 * Gradebook component name must exist in existing module.
 
-*Guarantees* :
-
-* NIL
+*Guarantees* : NIL
 
 *MSS* :
 
@@ -2033,9 +2005,7 @@ Use case resumes from step 1.
 
 * Students must be enrolled to the module.
 
-*Guarantees* :
-
-* NIL
+*Guarantees* : NIL
 
 *MSS* :
 
@@ -2064,9 +2034,7 @@ Use case resumes from step 1.
 * Grade component name must exist in existing module.
 * Marks assigned to student for the particular gradebook component must not exceed its maximum marks.
 
-*Guarantees* :
-
-* NIL
+*Guarantees* : NIL
 
 *MSS* :
 
@@ -2094,9 +2062,7 @@ Use case resumes from step 1.
 * Grade component name must exist in existing module.
 * Marks of all students taking the module should be added in.
 
-*Guarantees* :
-
-* NIL
+*Guarantees* : NIL
 
 *MSS* :
 

docs/UserGuide.adoc

@@ -433,10 +433,7 @@ Format: `gradebook add mc/MODULE_CODE cn/COMPONENT_NAME [mm/MAX_MARKS] [w/WEIGHT
 
 ****
 * Inputs are case sensitive.
-* Module code must exist
-* Gradebook Component name must not already exist in Trajectory.
-* Accumulated weightage for grade components in module cannot exceed 100%.
-* Weightage can be 0 for grade components like Mock Practical Exam.
+* Gradebook component name must NOT exist in existing module.
 ****
 
 Examples:
@@ -452,7 +449,6 @@ Format: `gradebook edit mc/MODULE_CODE cn/COMPONENT_NAME [ei/EDITED_COMPONENT_NA
 * Inputs are case sensitive.
 * Grade component name must exist in existing module.
 * Accumulated weightage including the updated weightage must not exceed 100%.
-* At least one optional parameter must be included in command.
 ****
 
 Examples:

docs/team/tristyxxnana.adoc

@@ -16,19 +16,12 @@ Trajectory is a lightweight management system for those who need a no-frills sol
 * *Major enhancement*: added *the ability to display a graph command for student grades*
 ** What it does: Allows the teacher to display a graph to show results of all students of a particular grade component in a module.
 ** Justification: This feature allows the teacher to monitor the progress of students conveniently through the use of a graph instead of a list of numbers.
-** Highlights: This enhancement requires an in-depth analysis of design as it gathers information from several features like Student Management, Module Management and Gradebook Management. Additionally, the data for the x and y axis (marks and number of students) respectively involves the use of a hash-map which involves comprehensive coding.
+** Highlights: This enhancement requires an in-depth analysis of design as it gathers information from several features like Student Management, Module Management and Gradebook Management.
 ** Credits: http://tutorials.jenkov.com/javafx/linechart.html
             https://docs.oracle.com/javase/8/javafx/api/javafx/scene/chart/LineChart.html
 * *Minor enhancement*: Added features for Gradebook Management and Grade Management
-** Gradebook Management
-*** Create gradebook component
-*** Read/Find gradebook component
-*** Update gradebook component
-*** Delete gradebook component
-** Grade Management
-*** Create student grade
-*** Delete student grade
-
+** Gradebook Management (Create, Find, Update, Delete, List Gradebook Component)
+** Grade Management (Create, Delete, List Student Grade)
 * *Other contributions*:
 
 ** Project management:
@@ -50,12 +43,6 @@ Trajectory is a lightweight management system for those who need a no-frills sol
 
 include::../UserGuide.adoc[tag=gradebook]
 
-include::../UserGuide.adoc[tag=grade]
-
-include::../UserGuide.adoc[tag=gradebookcommandsummary]
-
-include::../UserGuide.adoc[tag=gradecommandsummary]
-
 == Contributions to the Developer Guide
 
 |===
@@ -66,14 +53,5 @@ include::../DeveloperGuide.adoc[tag=logiccomponent]
 
 include::../DeveloperGuide.adoc[tag=graph]
 
-include::../DeveloperGuide.adoc[tag=gradebookuserstories]
-
-include::../DeveloperGuide.adoc[tag=gradeuserstories]
-
 include::../DeveloperGuide.adoc[tag=gradebookusecase]
 
-include::../DeveloperGuide.adoc[tag=gradeusecase]
-
-include::../DeveloperGuide.adoc[tag=gradebookmanualtesting]
-
-include::../DeveloperGuide.adoc[tag=grademanualtesting]