# Untitled

<h2 align="center">🏠 Taskist – User &#x26; Admin Guide</h2>

<p align="center"><a href="https://demo.taskist.org" class="button primary" data-icon="globe-pointer">Launch Demo</a> <a href="https://github.com/Taskist/taskist" class="button primary" data-icon="github">Github Repo</a></p>

<p align="center"></p>

Welcome to the **Taskist Documentation Portal** — your complete guide to understanding and using the Taskist system effectively.

Taskist is a **modern task, change, and bug management system** built for software teams, offering advanced project collaboration, workflow automation, and real-time visibility through modular, permission-driven design.

### 🚀 Introduction

**Taskist** helps development teams organize their projects, streamline communication, and deliver work efficiently.\
It brings together **backlogs, sprints, communication tools, and master configurations** into one unified workspace — fully customizable, visually intuitive, and scalable.

Taskist provides:

* 🧩 Modular architecture for easy configuration
* ⚙️ Role-based permissions for secure collaboration
* 🎨 Color-coded masters for intuitive visualization
* 🔔 Email integration for smart automation
* 🌐 Multi-language support for global usability

### 🧱 System Overview

Taskist is divided into three major areas:

| **Category**                            | **Modules Included**                                                       | **Purpose**                                              |
| --------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------- |
| **1️⃣ Core Functional Modules**         | Backlog, Sprint, Board *(planned)*                                         | Daily work management, task tracking, and Agile delivery |
| **2️⃣ Configuration & Master Modules**  | Status, Severity, Task Type, Reporter, Project, Module, Sub-Module, Client | Foundational definitions used across the system          |
| **3️⃣ System Settings & Communication** | Email Account, Email Template, Language, Locale Resource                   | Automation, notification, and localization setup         |

### 🧩 Core Functional Modules

#### 📋 **Backlog Module**

The heart of Taskist — where users log, manage, and track **tasks, CRs, and bugs**.\
Includes a **Backlog List View** with filtering, grouping, and search features, and a **Create/Edit interface** with full master integration.

Key highlights:

* Permission-based create/edit/close actions
* Color-coded severity, status, and task type
* Reopen count and history tracking
* Inline filters, column selection, and grouping
* Quick “#ID” search and detailed filtering
* Attachments, activity logs, and audit trails

Includes sub-sections:

* 👤 *Assignee Section* – Assign to self or eligible project members
* 🧾 *Attachments & Logs* – Manage supporting files and updates

#### 🏃‍♂️ **Sprint Module**

Used to define **iteration cycles** (Start Date → End Date) for managing sets of backlog items.\
Supports planning, execution, and tracking of work progress within a project.

Key features:

* Time-boxed sprint creation and activation
* Assign backlogs to active sprints
* One active sprint per project rule
* Sprint progress tracking and reports

#### 🗂️ **Board Module** *(Planned Feature)*

Future Kanban view of the Backlog module with **drag-and-drop task movement** between workflow stages.\
Will visualize tasks by **status, assignee, or sprint**, using color-coded indicators from master data.

### ⚙️ Configuration & Master Modules

These modules provide the structural foundation for projects and workflow logic.

| **Module**                 | **Purpose / Highlights**                                               |
| -------------------------- | ---------------------------------------------------------------------- |
| 🧩 **Project Module**      | Organizes clients, members, and custom fields under specific projects. |
| 🧱 **Sub-Module Module**   | Manages sub-sections linked to modules (e.g., Comments, Attachments).  |
| 🧾 **Client Module**       | Stores client or organization information linked to projects.          |
| 🧩 **Module & Sub-Module** | Define functional areas within projects (e.g., Tasks, Documents).      |
| 🚨 **Severity Module**     | Categorizes urgency and impact with visual color/icon settings.        |
| 🔄 **Status Module**       | Defines workflow stages like New, InProgress, Resolved, Archived.      |
| 🧾 **Task Type Module**    | Classifies tasks as To-Do, CR, or Bug with distinct visuals.           |
| 🧍‍♂️ **Reporter Module**  | Tracks **external individuals** (clients/testers) who report issues.   |
| 🧩 **Assignee Section**    | Embedded within Backlog; assigns tasks to users or eligible members.   |

### 📧 Communication & System Settings

Taskist automates notifications and supports localization through system-level configuration modules.

| **Module**                      | **Purpose / Integration**                                                                 |
| ------------------------------- | ----------------------------------------------------------------------------------------- |
| 📧 **Email Account Module**     | Stores all SMTP configurations used to send system emails.                                |
| 📨 **Email Template Module**    | Defines subject and body templates using tokens; linked to email accounts for sending.    |
| 🌐 **Language Module**          | Manages available system languages, default settings, and localization files.             |
| 🗝️ **Locale Resource Section** | Part of the Language Edit page — defines key-value translations for UI text and messages. |

### 🧭 Workflow Integration Overview

Taskist modules work together as part of a connected ecosystem:

<p align="center"></p>

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><strong>Join our Discord Community</strong></td><td>Connect with other <strong>Taskist</strong> users, share feedback, discuss new features, and get help directly from the community.</td><td><a href="https://discord.gg/UMFwMXaYrX" class="button primary">Join Discord</a></td><td data-object-fit="cover"><a href="https://1322755189-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXst6sArWsYPmWhDoL3Ny%2Fuploads%2Fq1SUpkfVyurkvI6vijuU%2Fdiscord.png?alt=media&#x26;token=79445a30-ff0c-4234-a821-2e571af24b20">discord.png</a></td></tr><tr><td><strong>Contribute on GitHub</strong></td><td>Help improve Taskist by reporting issues, suggesting enhancements, or submitting pull requests. <strong>Every contribution counts!</strong></td><td><a href="https://github.com/taskist/taskist" class="button primary">Submit a PR</a></td><td><a href="https://1322755189-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXst6sArWsYPmWhDoL3Ny%2Fuploads%2Fgmqg2iqP4NN1sdkzWBa3%2FGithub.png?alt=media&#x26;token=134d3169-01fe-470d-b635-c69b9c9e6dbf">Github.png</a></td></tr></tbody></table>