Added new help pages as per OKR - DO NOT MERGE (#9291)

* added help pages on Assessment, delete and restore documents and Document versioning, fixed #9262

* some fixes in help docs
This commit is contained in:
Umair Sayed 2017-06-14 19:40:08 +05:30 committed by Nabin Hait
parent 67c4f1713b
commit 0b8e19b5d8
30 changed files with 148 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 363 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 170 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 155 KiB

View File

@ -0,0 +1,13 @@
#Assessment Criteria
Assessment Criteria is the parameter based on which you assess the Student.
<img class="screenshot" alt="Assessment Criteria" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-criteria.png">
After assessment is conducted for a Course, marks earned are entered based on the Assessment Criteria. For example, if assessment was conducted for science subject, then you can evaluate Student in Science on various criteria like Writing, Practicals, Presentation etc.
Assessment Criteria is be used when scheduling Assessment Plan for Student Group and Course.
<img class="screenshot" alt="Assessment Plan Criteria" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-plan-criteria.png">
{next}

View File

@ -0,0 +1,13 @@
#Assessment Group
Assessment Group tree is a master where you can define the hierarchy for examination conducted in your education institute.
For example, if you conduct two assessment in a academic year, then setup Assessment Group as following.
<img class="screenshot" alt="Assessment Group Term" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-group-term.png">
On the same lines, you can also define multiple Assessment Group bases on assessment conducted in your institute.
<img class="screenshot" alt="Assessment Group Term" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-group-details.png">
{next}

View File

@ -0,0 +1,19 @@
#Assessment Plan
To schedule an assessment/examination for a Student Group, for specific Course, create Assessment Plan. In the Assessment Plan, you can also capture details like:
1. Grading Scale based on which grades will be assigned to students.
2. Schedule Date of Assessment
3. Room where assessment will be conducted
4. Examiner and Supervisor
<img class="screenshot" alt="Assessment Plan Details" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-plan-details.png">
5. Assessment Criteria is list of criteria based which each student in will be evaluated and grades will be assigned.
<img class="screenshot" alt="Assessment Plan Criteria" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-plan-criteria.png">
{next}

View File

@ -0,0 +1,7 @@
#Assessment Result
Assessment Result is a log of marks/grades earned by the student for specific Assessment. Assessment Result is created in the backend based on the marks entered in the [Assessment Result Tool]({{docs_base_url}}/user/manual/en/schools/assessment/assessment_result_tool.html).
<img class="screenshot" alt="Assessment Result" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-result.png">
{next}

View File

@ -0,0 +1,9 @@
#Assessment Result Tool
Assessment Result Tool help you entering marks earned by the Students for specific course. In this tool, based on the Assessment Plan, all the Student will be fetched into Assessment Result Tool. Also, Columns for Assessment Criteria will be where marks earned can be entered for each Student.
<img class="screenshot" alt="Assessment Result Tool" src="{{docs_base_url}}/assets/img/schools/assessment/assessment-result-tool.png">
As you go on entering marks for a Student, and switch to next student, in the backend, Student Result record will be auto-created for that Student.
{next}

View File

@ -0,0 +1,7 @@
#Grading Scale
In the Grading Scale, you can define various grades and threshold for them. Based on the score earned by an Student for an Assessment, Grade will be assigned.
<img class="screenshot" alt="Grading Scale" src="{{docs_base_url}}/assets/img/schools/assessment/grading-scale.png">
{next}

View File

@ -0,0 +1,17 @@
#Assessment
Every education institute organizes assessment / examination to evaluates progress of their Students. In ERPNext, you can manage complete assessment processing for your ERPNext account.
Following is the order in which you should setup masters in the Assessment module.
1. Assessment Criteria
2. Assessment Group
3. Grading Scale
Once you have also defined the Student Group and Courses, you can schedule an assessment / examination by creating Assessment Plan.
Based on the performance of Student in the assessment, you can create Assessment Result for an Student. You can create Assessment Results in bulk using Assessment Result Tool. In this tool, on selection of Assessment Plan, all the students (for Student Group) will be fetched. You can quickly enter marks earned by each Student for each Assessment Criteria in a single row.
### Topics
{index}

View File

@ -0,0 +1,6 @@
assessment_criteria
assessment_group
grading_scale
assessment_plan
assessment_result_tool
assessment_result

View File

@ -2,4 +2,5 @@ student
admission
schedule
fees
setup
setup
assessment

View File

@ -23,7 +23,7 @@ Warehouse” or both (if you are recording a movement).
**Additional Costs:**
If the stock entry is an incoming entry i.e any item is receiving at a target warehouse, you can add related additional costs (like Shipping Charges, Customs Duty, Operating Costs etc) assotiated with the process. The additional costs will be considered to calculate valuation rate of the items.
If the stock entry is an incoming entry i.e any item is receiving at a target warehouse, you can add related additional costs (like Shipping Charges, Customs Duty, Operating Costs etc) associated with the process. The additional costs will be considered to calculate valuation rate of the items.
To add additional costs, enter the description and amount of the cost in the Additional Costs table.

View File

@ -0,0 +1,21 @@
#Document Versioning
The document versioning feature allows you to track all the changes made in the form over the period. It will be very helpful in audit trial to check which user edited what value, and when exactly.
####Enable Document Versioning
Document Versioning can be enabled for one Document Type as a time. Let's assume that we need to enable it from Purchase Order. Then, we will check Customize Form tool for Purchase Order and check field `Track Changes`. With this, document versioning will be enabled for all the Purchase Orders create and edited hence forth.
<img class="screenshot" alt="Enable Versioning" src="{{docs_base_url}}/assets/img/collaboration-tools/enable-versioning.png">
####Version Log
Following is link of version in a Purchase Order form. Each time a document is edited, a version's link will be added in that document. To check more details on specific version, click on it's link.
<img class="screenshot" alt="Version Links" src="{{docs_base_url}}/assets/img/collaboration-tools/version-links.png">
####Version Details
In the Version document, you will find log of all the fields and values changes in it.
<img class="screenshot" alt="Version Details" src="{{docs_base_url}}/assets/img/collaboration-tools/version-details.png">

View File

@ -1,4 +1,6 @@
to-do
restore-deleted-docs
document-versioning
collaborating-around-forms
chat
notes

View File

@ -0,0 +1,31 @@
#Restore Deleted Documents
In ERPNext, you can delete a records if not needed. They can be masters like Items, Customer or transactions like Sales Order, Payment Entries etc.
<img class="screenshot" alt="Delete a Docuemnt" src="{{docs_base_url}}/assets/img/collaboration-tools/delete-a-doc.png">
If you have deleted an entry by mistake and wish to restore it back into your ERPNext account.
> Only User having System Manager role assigned can restore deleted documents.
Steps below to restore a deleted document.
####Step 1: Go to Deleted Documents
For the list of deleted document, just type Deleted Document in the Search Bar and go to list.
<img class="screenshot" alt="Deleted Docs List" src="{{docs_base_url}}/assets/img/collaboration-tools/deleted-docs-list.gif">
####Step 2: Open Doc and Restore
Open the document to be restored from the list. Click on Restore button.
<img class="screenshot" alt="Restored Doc" src="{{docs_base_url}}/assets/img/collaboration-tools/restore-a-doc.png">
####Step 3: Restored
Once a document is restored, you will be able to use it for creating entries in your ERPNext account.
<img class="screenshot" alt="Restored Doc" src="{{docs_base_url}}/assets/img/collaboration-tools/restored-doc.png">
> If canceled document is deleted, then it will not be restored.