From d9dfbae718ad86767a0dc3f9e3b97240097b1e2e Mon Sep 17 00:00:00 2001 From: Rushabh Mehta Date: Tue, 11 Jun 2013 15:03:41 +0530 Subject: [PATCH] [docs] added readme for hr module --- hr/README.md | 6 ++++++ hr/doctype/appraisal/README.md | 1 + hr/doctype/appraisal_goal/README.md | 1 + hr/doctype/appraisal_template/README.md | 1 + hr/doctype/appraisal_template_goal/README.md | 1 + hr/doctype/attendance/README.md | 1 + hr/doctype/branch/README.md | 1 + hr/doctype/deduction_type/README.md | 3 +++ hr/doctype/department/README.md | 1 + hr/doctype/designation/README.md | 1 + hr/doctype/earning_type/README.md | 3 +++ hr/doctype/employee/README.md | 1 + hr/doctype/employee_education/README.md | 1 + hr/doctype/employee_external_work_history/README.md | 1 + hr/doctype/employee_internal_work_history/README.md | 1 + hr/doctype/employee_leave_approver/README.md | 1 + hr/doctype/employment_type/README.md | 3 +++ hr/doctype/expense_claim/README.md | 1 + hr/doctype/expense_claim_detail/README.md | 1 + hr/doctype/expense_claim_type/README.md | 1 + hr/doctype/grade/README.md | 1 + hr/doctype/holiday/README.md | 1 + hr/doctype/holiday_list/README.md | 1 + hr/doctype/job_applicant/README.md | 1 + hr/doctype/job_opening/README.md | 1 + hr/doctype/leave_allocation/README.md | 1 + hr/doctype/leave_application/README.md | 1 + hr/doctype/leave_block_list/README.md | 1 + hr/doctype/leave_block_list_allow/README.md | 1 + hr/doctype/leave_block_list_date/README.md | 1 + hr/doctype/leave_control_panel/README.md | 1 + hr/doctype/leave_type/README.md | 6 ++++++ hr/doctype/salary_manager/README.md | 1 + hr/doctype/salary_slip/README.md | 1 + hr/doctype/salary_slip_deduction/README.md | 5 +++++ hr/doctype/salary_slip_earning/README.md | 6 ++++++ hr/doctype/salary_structure/README.md | 1 + hr/doctype/salary_structure_deduction/README.md | 1 + hr/doctype/salary_structure_earning/README.md | 1 + hr/doctype/upload_attendance/README.md | 1 + 40 files changed, 65 insertions(+) create mode 100644 hr/README.md create mode 100644 hr/doctype/appraisal/README.md create mode 100644 hr/doctype/appraisal_goal/README.md create mode 100644 hr/doctype/appraisal_template/README.md create mode 100644 hr/doctype/appraisal_template_goal/README.md create mode 100644 hr/doctype/attendance/README.md create mode 100644 hr/doctype/branch/README.md create mode 100644 hr/doctype/deduction_type/README.md create mode 100644 hr/doctype/department/README.md create mode 100644 hr/doctype/designation/README.md create mode 100644 hr/doctype/earning_type/README.md create mode 100644 hr/doctype/employee/README.md create mode 100644 hr/doctype/employee_education/README.md create mode 100644 hr/doctype/employee_external_work_history/README.md create mode 100644 hr/doctype/employee_internal_work_history/README.md create mode 100644 hr/doctype/employee_leave_approver/README.md create mode 100644 hr/doctype/employment_type/README.md create mode 100644 hr/doctype/expense_claim/README.md create mode 100644 hr/doctype/expense_claim_detail/README.md create mode 100644 hr/doctype/expense_claim_type/README.md create mode 100644 hr/doctype/grade/README.md create mode 100644 hr/doctype/holiday/README.md create mode 100644 hr/doctype/holiday_list/README.md create mode 100644 hr/doctype/job_applicant/README.md create mode 100644 hr/doctype/job_opening/README.md create mode 100644 hr/doctype/leave_allocation/README.md create mode 100644 hr/doctype/leave_application/README.md create mode 100644 hr/doctype/leave_block_list/README.md create mode 100644 hr/doctype/leave_block_list_allow/README.md create mode 100644 hr/doctype/leave_block_list_date/README.md create mode 100644 hr/doctype/leave_control_panel/README.md create mode 100644 hr/doctype/leave_type/README.md create mode 100644 hr/doctype/salary_manager/README.md create mode 100644 hr/doctype/salary_slip/README.md create mode 100644 hr/doctype/salary_slip_deduction/README.md create mode 100644 hr/doctype/salary_slip_earning/README.md create mode 100644 hr/doctype/salary_structure/README.md create mode 100644 hr/doctype/salary_structure_deduction/README.md create mode 100644 hr/doctype/salary_structure_earning/README.md create mode 100644 hr/doctype/upload_attendance/README.md diff --git a/hr/README.md b/hr/README.md new file mode 100644 index 0000000000..5d1ae6e4ba --- /dev/null +++ b/hr/README.md @@ -0,0 +1,6 @@ +Key features: + +- Leave and Attendance +- Payroll +- Appraisal +- Expense Claim \ No newline at end of file diff --git a/hr/doctype/appraisal/README.md b/hr/doctype/appraisal/README.md new file mode 100644 index 0000000000..7798f188cc --- /dev/null +++ b/hr/doctype/appraisal/README.md @@ -0,0 +1 @@ +Performance of an Employee in a Time Period against given goals. \ No newline at end of file diff --git a/hr/doctype/appraisal_goal/README.md b/hr/doctype/appraisal_goal/README.md new file mode 100644 index 0000000000..851a403bde --- /dev/null +++ b/hr/doctype/appraisal_goal/README.md @@ -0,0 +1 @@ +Goal for the parent Appraisal. \ No newline at end of file diff --git a/hr/doctype/appraisal_template/README.md b/hr/doctype/appraisal_template/README.md new file mode 100644 index 0000000000..d58a744867 --- /dev/null +++ b/hr/doctype/appraisal_template/README.md @@ -0,0 +1 @@ +Standard set of goals for an Employee / Designation / Job Profile. New Appraisal transactions can be created from the Template. \ No newline at end of file diff --git a/hr/doctype/appraisal_template_goal/README.md b/hr/doctype/appraisal_template_goal/README.md new file mode 100644 index 0000000000..1b81afbfce --- /dev/null +++ b/hr/doctype/appraisal_template_goal/README.md @@ -0,0 +1 @@ +Goal details for the parent Appraisal Template. \ No newline at end of file diff --git a/hr/doctype/attendance/README.md b/hr/doctype/attendance/README.md new file mode 100644 index 0000000000..f420b0709c --- /dev/null +++ b/hr/doctype/attendance/README.md @@ -0,0 +1 @@ +Attendance record of an Employee on a particular date. \ No newline at end of file diff --git a/hr/doctype/branch/README.md b/hr/doctype/branch/README.md new file mode 100644 index 0000000000..9f679ec75f --- /dev/null +++ b/hr/doctype/branch/README.md @@ -0,0 +1 @@ +Location belonging to the organization where Employees can belong. \ No newline at end of file diff --git a/hr/doctype/deduction_type/README.md b/hr/doctype/deduction_type/README.md new file mode 100644 index 0000000000..2a22774935 --- /dev/null +++ b/hr/doctype/deduction_type/README.md @@ -0,0 +1,3 @@ +Type of salary deduction. + +e.g. Tax paid on behalf of the employee that is deducted from the salary. \ No newline at end of file diff --git a/hr/doctype/department/README.md b/hr/doctype/department/README.md new file mode 100644 index 0000000000..6f74b863a8 --- /dev/null +++ b/hr/doctype/department/README.md @@ -0,0 +1 @@ +Department where Employee belongs. \ No newline at end of file diff --git a/hr/doctype/designation/README.md b/hr/doctype/designation/README.md new file mode 100644 index 0000000000..a02a923f66 --- /dev/null +++ b/hr/doctype/designation/README.md @@ -0,0 +1 @@ +Employee Designation. \ No newline at end of file diff --git a/hr/doctype/earning_type/README.md b/hr/doctype/earning_type/README.md new file mode 100644 index 0000000000..50aa1b3bf5 --- /dev/null +++ b/hr/doctype/earning_type/README.md @@ -0,0 +1,3 @@ +Type of earning that is a part of the salary. + +e.g. basic salary, bonus etc. \ No newline at end of file diff --git a/hr/doctype/employee/README.md b/hr/doctype/employee/README.md new file mode 100644 index 0000000000..f82e99a3c6 --- /dev/null +++ b/hr/doctype/employee/README.md @@ -0,0 +1 @@ +Employee master. \ No newline at end of file diff --git a/hr/doctype/employee_education/README.md b/hr/doctype/employee_education/README.md new file mode 100644 index 0000000000..4d7ccee157 --- /dev/null +++ b/hr/doctype/employee_education/README.md @@ -0,0 +1 @@ +Education detail for parent Employee. \ No newline at end of file diff --git a/hr/doctype/employee_external_work_history/README.md b/hr/doctype/employee_external_work_history/README.md new file mode 100644 index 0000000000..6564377148 --- /dev/null +++ b/hr/doctype/employee_external_work_history/README.md @@ -0,0 +1 @@ +External work history details of parent Employee. \ No newline at end of file diff --git a/hr/doctype/employee_internal_work_history/README.md b/hr/doctype/employee_internal_work_history/README.md new file mode 100644 index 0000000000..8f7fb3f2b0 --- /dev/null +++ b/hr/doctype/employee_internal_work_history/README.md @@ -0,0 +1 @@ +Work history details of parent Employee within the organization. \ No newline at end of file diff --git a/hr/doctype/employee_leave_approver/README.md b/hr/doctype/employee_leave_approver/README.md new file mode 100644 index 0000000000..329e93c8b4 --- /dev/null +++ b/hr/doctype/employee_leave_approver/README.md @@ -0,0 +1 @@ +User authorized to approve Leave Application for an Employee. \ No newline at end of file diff --git a/hr/doctype/employment_type/README.md b/hr/doctype/employment_type/README.md new file mode 100644 index 0000000000..19de703b24 --- /dev/null +++ b/hr/doctype/employment_type/README.md @@ -0,0 +1,3 @@ +Type of employment. + +e.g. Permanent, Probation, Intern etc. \ No newline at end of file diff --git a/hr/doctype/expense_claim/README.md b/hr/doctype/expense_claim/README.md new file mode 100644 index 0000000000..489029ce39 --- /dev/null +++ b/hr/doctype/expense_claim/README.md @@ -0,0 +1 @@ +Amount claimed by Employee for expense made by the Employee on organization's behalf. \ No newline at end of file diff --git a/hr/doctype/expense_claim_detail/README.md b/hr/doctype/expense_claim_detail/README.md new file mode 100644 index 0000000000..4a747e2ea5 --- /dev/null +++ b/hr/doctype/expense_claim_detail/README.md @@ -0,0 +1 @@ +Detail of expense in parent Expense Claim. \ No newline at end of file diff --git a/hr/doctype/expense_claim_type/README.md b/hr/doctype/expense_claim_type/README.md new file mode 100644 index 0000000000..13a654eab2 --- /dev/null +++ b/hr/doctype/expense_claim_type/README.md @@ -0,0 +1 @@ +Type of expense for Expense Claim. \ No newline at end of file diff --git a/hr/doctype/grade/README.md b/hr/doctype/grade/README.md new file mode 100644 index 0000000000..fedc03bd64 --- /dev/null +++ b/hr/doctype/grade/README.md @@ -0,0 +1 @@ +Employee grade. \ No newline at end of file diff --git a/hr/doctype/holiday/README.md b/hr/doctype/holiday/README.md new file mode 100644 index 0000000000..0d932a9eee --- /dev/null +++ b/hr/doctype/holiday/README.md @@ -0,0 +1 @@ +Holiday date in Holiday List. \ No newline at end of file diff --git a/hr/doctype/holiday_list/README.md b/hr/doctype/holiday_list/README.md new file mode 100644 index 0000000000..1652c0a1ab --- /dev/null +++ b/hr/doctype/holiday_list/README.md @@ -0,0 +1 @@ +List of Holidays. \ No newline at end of file diff --git a/hr/doctype/job_applicant/README.md b/hr/doctype/job_applicant/README.md new file mode 100644 index 0000000000..8eb2edbda0 --- /dev/null +++ b/hr/doctype/job_applicant/README.md @@ -0,0 +1 @@ +Applicant for Job. \ No newline at end of file diff --git a/hr/doctype/job_opening/README.md b/hr/doctype/job_opening/README.md new file mode 100644 index 0000000000..5a19f33c8e --- /dev/null +++ b/hr/doctype/job_opening/README.md @@ -0,0 +1 @@ +Open position for Job. \ No newline at end of file diff --git a/hr/doctype/leave_allocation/README.md b/hr/doctype/leave_allocation/README.md new file mode 100644 index 0000000000..870f9a501a --- /dev/null +++ b/hr/doctype/leave_allocation/README.md @@ -0,0 +1 @@ +Leave Allocated to an Employee at the beginning of the period. \ No newline at end of file diff --git a/hr/doctype/leave_application/README.md b/hr/doctype/leave_application/README.md new file mode 100644 index 0000000000..e78e37a1c2 --- /dev/null +++ b/hr/doctype/leave_application/README.md @@ -0,0 +1 @@ +Application for Leave by an Employee. \ No newline at end of file diff --git a/hr/doctype/leave_block_list/README.md b/hr/doctype/leave_block_list/README.md new file mode 100644 index 0000000000..b23396c4a3 --- /dev/null +++ b/hr/doctype/leave_block_list/README.md @@ -0,0 +1 @@ +List of days on which leaves can only be approved by special users. \ No newline at end of file diff --git a/hr/doctype/leave_block_list_allow/README.md b/hr/doctype/leave_block_list_allow/README.md new file mode 100644 index 0000000000..a735039a1a --- /dev/null +++ b/hr/doctype/leave_block_list_allow/README.md @@ -0,0 +1 @@ +User allowed to approve leave on blocked date. \ No newline at end of file diff --git a/hr/doctype/leave_block_list_date/README.md b/hr/doctype/leave_block_list_date/README.md new file mode 100644 index 0000000000..658f35985d --- /dev/null +++ b/hr/doctype/leave_block_list_date/README.md @@ -0,0 +1 @@ +Date blocked on parent Leave Block List. \ No newline at end of file diff --git a/hr/doctype/leave_control_panel/README.md b/hr/doctype/leave_control_panel/README.md new file mode 100644 index 0000000000..f7d3357570 --- /dev/null +++ b/hr/doctype/leave_control_panel/README.md @@ -0,0 +1 @@ +Tool to allocate leaves in bulk. \ No newline at end of file diff --git a/hr/doctype/leave_type/README.md b/hr/doctype/leave_type/README.md new file mode 100644 index 0000000000..695e9ddafc --- /dev/null +++ b/hr/doctype/leave_type/README.md @@ -0,0 +1,6 @@ +Type of Leave. + +e.g. + +- Casual Leave +- Sick Leave \ No newline at end of file diff --git a/hr/doctype/salary_manager/README.md b/hr/doctype/salary_manager/README.md new file mode 100644 index 0000000000..040d038ec0 --- /dev/null +++ b/hr/doctype/salary_manager/README.md @@ -0,0 +1 @@ +Tool to issue monthly Salary Slips to all Employees. \ No newline at end of file diff --git a/hr/doctype/salary_slip/README.md b/hr/doctype/salary_slip/README.md new file mode 100644 index 0000000000..736550e42c --- /dev/null +++ b/hr/doctype/salary_slip/README.md @@ -0,0 +1 @@ +Details of monthly salary paid for an Employee. \ No newline at end of file diff --git a/hr/doctype/salary_slip_deduction/README.md b/hr/doctype/salary_slip_deduction/README.md new file mode 100644 index 0000000000..d0f2219e83 --- /dev/null +++ b/hr/doctype/salary_slip_deduction/README.md @@ -0,0 +1,5 @@ +Deduction detail in parent Salary Slip. + +e.g. + +- Tax paid on employee's behalf \ No newline at end of file diff --git a/hr/doctype/salary_slip_earning/README.md b/hr/doctype/salary_slip_earning/README.md new file mode 100644 index 0000000000..9da0167f5b --- /dev/null +++ b/hr/doctype/salary_slip_earning/README.md @@ -0,0 +1,6 @@ +Earning detail in parent Salary Slip. + +e.g. + +- Basic Salary +- Performance Bonus diff --git a/hr/doctype/salary_structure/README.md b/hr/doctype/salary_structure/README.md new file mode 100644 index 0000000000..3795971c11 --- /dev/null +++ b/hr/doctype/salary_structure/README.md @@ -0,0 +1 @@ +Salary Template for an Employee, basis of which monthly Salary is calculated. \ No newline at end of file diff --git a/hr/doctype/salary_structure_deduction/README.md b/hr/doctype/salary_structure_deduction/README.md new file mode 100644 index 0000000000..085353910d --- /dev/null +++ b/hr/doctype/salary_structure_deduction/README.md @@ -0,0 +1 @@ +Deduction details in parent Salary Structure. \ No newline at end of file diff --git a/hr/doctype/salary_structure_earning/README.md b/hr/doctype/salary_structure_earning/README.md new file mode 100644 index 0000000000..d495cc4e0e --- /dev/null +++ b/hr/doctype/salary_structure_earning/README.md @@ -0,0 +1 @@ +Earning details in parent Salary Structure. \ No newline at end of file diff --git a/hr/doctype/upload_attendance/README.md b/hr/doctype/upload_attendance/README.md new file mode 100644 index 0000000000..d0b3721016 --- /dev/null +++ b/hr/doctype/upload_attendance/README.md @@ -0,0 +1 @@ +Tool to upload attendance via csv file. \ No newline at end of file