Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .vitepress/routes/master.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,36 @@ const routes = [
{ text: 'Settings', link: '/master/manufacturing/settings' },
]
},
{
text: 'Maintenance',
collapsed: false,
items: [
{
text: 'Operations',
collapsed: true,
items: [
{ text: 'Maintenance Requests', link: '/master/maintenance/operations/maintenance-requests' },
{ text: 'Maintenance Calendar', link: '/master/maintenance/operations/calendar' },
]
},
{
text: 'Equipment',
collapsed: true,
items: [
{ text: 'Equipment', link: '/master/maintenance/equipments/equipments' },
]
},
{
text: 'Configurations',
collapsed: true,
items: [
{ text: 'Categories', link: '/master/maintenance/configurations/categories' },
{ text: 'Teams', link: '/master/maintenance/configurations/teams' },
{ text: 'Stages', link: '/master/maintenance/configurations/stages' },
]
},
]
},
{
text: 'Contacts',
collapsed: false,
Expand Down
4 changes: 4 additions & 0 deletions src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ features:
title: Manufacturing Management
details: Plan production, manage BoMs, and track work orders on the shop floor.
link: /master/manufacturing/operations/manufacturing-orders.md
- icon: 🔧
title: Maintenance Management
details: Track equipment, schedule preventive maintenance, and log corrective requests.
link: /master/maintenance/operations/maintenance-requests.md
- icon: 🎓
title: Recruitment System
details: Simplify recruitment and find the best talent with ease.
Expand Down
65 changes: 65 additions & 0 deletions src/master/maintenance/configurations/categories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Equipment Categories

An **Equipment Category** is a label you use to group similar pieces of [Equipment](../equipments/equipments.md) together — for example *Computers*, *Vehicles*, *Office Furniture*, or *Heavy Machinery*.
Each category can have a **default responsible technician**, so every new equipment placed in that category automatically inherits the right person to look after it.

**Use Case:**
Create a category for every type of asset you maintain. This makes filtering, reporting, and assigning the right technician much faster.

> **In simple words:** A Category is a *folder* for similar equipment. Put all your laptops in a "Computers" category, all your trucks in a "Vehicles" category, and so on.

## Steps to Create a New Equipment Category

1. Navigate to **`Maintenance → Configurations → Categories`** as shown below:

<ImagePopup src="/images1/maintenance/category_navigation.png" alt="Equipment Categories Navigation" />

2. Click **New Category** and fill in the following details:

#### General Information

- **_Name:_** The name of the category (e.g. `Computers`, `Vehicles`, `Printers`). Must be unique.
- **_Responsible:_** The default technician who looks after every equipment placed in this category. New equipment will pick this person automatically.
- **_Company:_** The company the category belongs to (useful in multi-company setups).
- **_Note:_** A free-text description — anything that helps explain what kind of equipment belongs in this category.

<ImagePopup src="/images1/maintenance/category_general_section.png" alt="Equipment Category General Section" />

3. **Action Buttons:**

- **Create** – Save and open the category record.
- **Create & Create Another** – Save and open a blank form for the next category.
- **Cancel** – Discard and return to the list.

## Category View Page

After creation, you are redirected to the **Category View Page** which summarizes the general information you saved.

<ImagePopup src="/images1/maintenance/category_view_page.png" alt="Equipment Category View Page" />

You can also:

- **Edit:** Modify any saved field.
- **Delete:** Remove the category. *Note:* deleting a category does not delete the equipment inside it — those records simply lose their category.

## List View — Groups & Actions

The **Categories** list view shows every category with the following columns: **Name**, **Responsible**, **Company**, and **Created At**.

You can:

- **Group by:** Responsible.
- **Search by:** Name.
- **Bulk Actions:** Delete selected categories.

<ImagePopup src="/images1/maintenance/category_list_view.png" alt="Equipment Category List View" />

### Summary

Equipment Categories help you:

- Group similar [Equipment](../equipments/equipments.md) together for easy filtering and reporting.
- Automatically assign the right default technician to every new equipment.
- Keep your equipment list organized as it grows.

> **Next step:** After creating categories, set up your [Maintenance Teams](teams.md) and the [Stages](stages.md) used in maintenance requests.
65 changes: 65 additions & 0 deletions src/master/maintenance/configurations/stages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Stages

A **Stage** represents a step in the lifecycle of a [Maintenance Request](../operations/maintenance-requests.md) — for example *New Request* → *In Progress* → *Repaired* → *Scrap*.
Stages appear as a progress bar on top of every request so the technician can see exactly where the work is and move it forward with one click.

**Use Case:**
Customize the stages to match how your maintenance team actually works. You can add, rename, or reorder stages, and mark certain stages as **Done** so the system knows the request is closed.

> **In simple words:** Stages are the *steps* a maintenance request goes through. The system ships with sensible defaults — change them only if your team uses different names.

## Default Stages

When the Maintenance plugin is installed, the following stages are created automatically:

| Order | Stage Name | Done? |
| ----- | -------------- | ----- |
| 1 | New Request | No |
| 2 | In Progress | No |
| 3 | Repaired | Yes |
| 4 | Scrap | Yes |

Requests in **Done** stages are treated as closed. For **preventive recurring** requests, moving to a Done stage also triggers the system to automatically create the *next* recurring request.

## Steps to Create a New Stage

1. Navigate to **`Maintenance → Configurations → Stages`** as shown below:

<ImagePopup src="/images1/maintenance/stage_navigation.png" alt="Stages Navigation" />

2. Click **New Stage** and fill in:

- **_Name:_** The display name of the stage (e.g. `Waiting for Parts`, `Quality Check`). Must be unique.
- **_Done:_** Toggle **ON** if a request reaching this stage should be considered **closed/complete**. Leave **OFF** for in-progress stages.

<ImagePopup src="/images1/maintenance/stage_general_section.png" alt="Stage General Section" />

3. **Action Buttons:**

- **Create** – Save the new stage.
- **Cancel** – Discard.

## List View — Reordering & Actions

The **Stages** list view shows every stage with the following columns: **Name** and **Done**.

You can:

- **Reorder Stages:** Drag-and-drop stages to change the order in which they appear on the request progress bar.
- **Group by:** Done status or Created date.
- **Edit:** Rename a stage or change its Done flag.
- **Delete:** Remove a stage. *Be careful* — deleting a stage that requests are using will fail.

<ImagePopup src="/images1/maintenance/stage_list_view.png" alt="Stage List View" />

### Summary

Stages give you:

- A clear visual workflow for every [Maintenance Request](../operations/maintenance-requests.md).
- Control over what "done" means for your team.
- Automatic generation of the next request when a recurring preventive request is closed.

> **Tip:** Keep the number of stages small — 3 to 5 stages usually work best. More than that and the progress bar becomes hard to read.

> **Next step:** With stages, [Teams](teams.md), and [Categories](categories.md) configured, you are ready to start creating [Maintenance Requests](../operations/maintenance-requests.md).
52 changes: 52 additions & 0 deletions src/master/maintenance/configurations/teams.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Maintenance Teams

A **Maintenance Team** is a group of users who are collectively responsible for taking care of a set of [Equipment](../equipments/equipments.md) and handling [Maintenance Requests](../operations/maintenance-requests.md).
Examples: *IT Support Team*, *Facility Team*, *Mechanical Team*.

**Use Case:**
Create one team per maintenance department or area of expertise. When a new request is raised, you simply pick the right team and the work lands in the right hands.

> **In simple words:** A Team is a *crew* of people who fix things together. Add the right team members and assign the team to your equipment.

## Steps to Create a New Maintenance Team

1. Navigate to **`Maintenance → Configurations → Teams`** as shown below:

<ImagePopup src="/images1/maintenance/team_navigation.png" alt="Maintenance Teams Navigation" />

2. Click **New Team** and fill in the following details:

- **_Name:_** The name of the team (e.g. `IT Support`, `Facility Maintenance`). Must be unique.
- **_Team Members:_** Select one or more users who are part of this team. You can add as many people as needed.
- **_Company:_** The company the team belongs to (useful in multi-company setups).

<ImagePopup src="/images1/maintenance/team_general_section.png" alt="Maintenance Team General Section" />

3. **Action Buttons:**

- **Create** – Save the new team.
- **Create & Create Another** – Save and open a blank form for the next team.
- **Cancel** – Discard and return to the list.

## List View — Columns & Actions

The **Teams** list view shows every maintenance team with the following columns: **Name**, **Company**, and **Team Members** (shown as badges).

You can:

- **Search by:** Name.
- **Edit:** Update the team name, members, or company.
- **Archive / Restore:** Soft-delete a team. Archived teams are hidden from selection lists but kept in the database. You can restore them later.
- **Delete (Permanent):** Force-delete a team if it is not used by any equipment or request.

<ImagePopup src="/images1/maintenance/team_list_view.png" alt="Maintenance Team List View" />

### Summary

Maintenance Teams help you:

- Route each [Maintenance Request](../operations/maintenance-requests.md) to the right group of people.
- Assign a default team to each piece of [Equipment](../equipments/equipments.md).
- Keep accountability clear — every request always has a team responsible.

> **Next step:** After creating teams, define the workflow [Stages](stages.md) used in maintenance requests.
101 changes: 101 additions & 0 deletions src/master/maintenance/equipments/equipments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Equipment

In the **Maintenance** module, an **Equipment** is any physical asset your company owns and needs to keep in good working condition — for example a *Laptop*, *Printer*, *CNC Machine*, *Forklift*, or *Air Conditioner*.
Each equipment record stores its identity (model, serial number), who owns it, who looks after it, when it was purchased, and how often it is expected to fail.

**Use Case:**
Create an equipment record for every machine, tool, vehicle, or device you want to track. Once an equipment exists in the system, you can raise [Maintenance Requests](../operations/maintenance-requests.md) against it, assign a technician, and monitor how often it breaks down.

> **In simple words:** Equipment is the *thing you take care of*. Before you can log a repair or schedule a check-up, the item must exist here.

## Steps to Create a New Equipment

1. Navigate to **`Maintenance → Equipment`** as shown below:

<ImagePopup src="/images1/maintenance/equipment_navigation.png" alt="Equipment Navigation" />

2. Fill in the following details:

#### General Information

- **_Name:_** The name of the equipment (e.g. `Laptop - Dell Latitude 5420`). This is shown everywhere the equipment is referenced.
- **_Description:_** A free-text note describing the equipment, its purpose, or any extra information that helps identify it.

<ImagePopup src="/images1/maintenance/equipment_general_section.png" alt="Equipment General Section" />

#### Product Information

- **_Vendor:_** The supplier or vendor from whom the equipment was purchased.
- **_Vendor Reference:_** The reference number or code given by the vendor (e.g. invoice number, vendor SKU).
- **_Model:_** Model name or number of the equipment (e.g. `Latitude 5420`).
- **_Serial Number:_** Unique serial number printed on the equipment — useful for warranty claims and traceability.
- **_Effective Date:_** The date the equipment was put into use. This is the starting point the system uses to calculate the **Mean Time Between Failures (MTBF)**.
- **_Cost:_** The purchase or acquisition cost of the equipment.
- **_Warranty Expiration Date:_** The date when the vendor warranty ends. Useful for planning replacements or claiming repairs under warranty.

<ImagePopup src="/images1/maintenance/equipment_product_information.png" alt="Equipment Product Information" />

#### Settings

- **_Equipment Category:_** Choose a [Category](../configurations/categories.md) (e.g. *Computers*, *Vehicles*, *Tools*) to group similar equipment together. Selecting a category auto-fills the default technician for that category.
- **_Maintenance Team:_** The [Team](../configurations/teams.md) responsible for taking care of this equipment.
- **_Company:_** The company that owns this equipment (useful in multi-company setups).
- **_Technician:_** The person primarily responsible for maintaining this equipment. Defaults to the technician set on the chosen category.
- **_Owner:_** The user who owns or uses this equipment day-to-day (e.g. the employee a laptop is assigned to).
- **_Used in Location:_** Free-text field describing where the equipment is physically located (e.g. *Floor 2, Cabin 12*, *Warehouse A*).

<ImagePopup src="/images1/maintenance/equipment_settings_section.png" alt="Equipment Settings Section" />

#### Maintenance

- **_Expected Mean Time Between Failure:_** The number of days you expect the equipment to run between two breakdowns. Helps you plan preventive maintenance before the next failure is due.

<ImagePopup src="/images1/maintenance/equipment_maintenance_section.png" alt="Equipment Maintenance Section" />

3. **Action Buttons:**

- **Create** – Save and open the equipment record.
- **Create & Create Another** – Save and immediately open another blank form.
- **Cancel** – Discard the entry and return to the list view.

## Equipment View Page

After creation, you are redirected to the **Equipment View Page**, where you can review every detail.

<ImagePopup src="/images1/maintenance/equipment_view_page.png" alt="Equipment View Page" />

On this page you can see:

- **General Information** — name and description.
- **Product Information** — vendor, model, serial number, cost, dates.
- **Settings** — category, team, technician, owner, location.
- **Maintenance** — expected MTBF, total maintenance count, currently open maintenance count, assigned date, and scrap date.

You can also:

- **Edit:** Modify any saved field.
- **Delete / Archive:** Remove or archive the equipment. Archived equipment stays in the database but no longer appears in selection lists.

## List View — Filters, Groups & Actions

The **Equipment** list view shows every equipment record with the following columns: **Equipment Name**, **Owner**, **Serial Number**, **Technician**, **Equipment Category**, and **Company**.

You can:

- **Filter by:** Equipment Category, Maintenance Team, or Technician.
- **Group by:** Technician, Equipment Category, Owner, or Vendor.
- **Search by:** Name or Serial Number.
- **Bulk Actions:** Archive, restore, or permanently delete selected equipment.

<ImagePopup src="/images1/maintenance/equipment_list_view.png" alt="Equipment List View" />

### Summary

The **Equipment** section is the foundation of the Maintenance module. By keeping every asset listed here with the right category, team, and technician, you can:

- Raise [Maintenance Requests](../operations/maintenance-requests.md) for any breakdown or check-up.
- Track how many times each equipment has been repaired.
- Plan **preventive maintenance** using the expected MTBF.
- Get warranty alerts before the warranty expires.

> **Next step:** Once your equipment is added, set up the supporting [Categories](../configurations/categories.md), [Teams](../configurations/teams.md), and [Stages](../configurations/stages.md), and then start logging [Maintenance Requests](../operations/maintenance-requests.md).
Loading