diff --git a/README.md b/README.md index 56d1279..e489520 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,6 @@ The first official release of the **Personal Lines Task Tracker** — a gamified --- -## 🛠 Endpoints & API - -- `/login`, `/logout`, `/control-center` — Admin authentication & dashboard -- `/get-all-data`, `/task-templates`, `/announcement` — Data retrieval and management -- `/agent/:agentId/start-story` — Begin seasonal or light story for an agent -- `/agent/:agentId/story-action` — Process a story action with energy validation -- `/agent/:agentId/reset` — Reset an agent’s story progress and daily tasks -- `/tasks/:agentId/:date/:taskId/status` — Update task status for a given date -- `/agents/:id` — Delete an agent - ---- - ## 📖 Story Content - **Seasonal Story Arc** — Dark, immersive 30-day storyline with branching daily actions. @@ -44,4 +32,116 @@ The first official release of the **Personal Lines Task Tracker** — a gamified --- -This release establishes the foundation of the **Personal Lines Task Tracker**, combining productivity tracking with engaging narrative gameplay to boost agent engagement and performance. +## 🧭 How to Use the Task Tracker + +### Objective +This SOP outlines the steps to effectively use the task tracker for managing assigned tasks and personal to-do lists. + +--- + +### 1. Accessing Your To-Do List +[▶ View on Loom (0:00)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=0) +![To-Do List](https://loom.com/i/4dec354190264dd1983747b8e41fa832?workflows_screenshot=true) +- Open the task tracker to view your to-do list. +- Assigned tasks will appear here. + +--- + +### 2. Editing Task Details +[▶ View on Loom (0:07)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=7) +![Editing Tasks](https://loom.com/i/931e43ac86af4e4e88028aba0eb832e5?workflows_screenshot=true) +- Click the pencil icon next to a task to edit. +- Make the title more descriptive. +- Change the urgency level (low, medium, high, very high, critical). + +--- + +### 3. Adding Notes to Tasks +[▶ View on Loom (0:15)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=15) +![Adding Notes](https://loom.com/i/ef375326034c4fdb85c62ea39cf62561?workflows_screenshot=true) +- Add notes in the designated area. +- Use `**double asterisks**` for bold text. +- Use `*single asterisk*` for bulleted lists. + +--- + +### 4. Completing a Task +[▶ View on Loom (0:31)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=31) +![Completing Tasks](https://loom.com/i/801d79e486764fd18278677aa098ce71?workflows_screenshot=true) +- Check the box next to the task to mark it as complete. +- The task will move to the completed section. + +--- + +### 5. Understanding the Points System +[▶ View on Loom (0:44)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=44) +![Points System](https://loom.com/i/baadb2d1a7b846aa91951e778b0148aa?workflows_screenshot=true) +- Points help ensure equitable workload distribution. +- Monitor your active, waiting on, rollover, and completed points. + +--- + +### 6. Managing Rollover Tasks +[▶ View on Loom (1:25)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=85) +![Rollover Tasks](https://loom.com/i/8d4b16b5276e4473b4346f0160bc6e03?workflows_screenshot=true) +- Uncheck a task to move it to rollover if not completed that day. + +--- + +### 7. Moving Tasks to "Waiting On" +[▶ View on Loom (2:05)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=125) +![Waiting On Tasks](https://loom.com/i/8e3324e8973146fb960f5106646ea5c2?workflows_screenshot=true) +- Drag tasks to the **Waiting On** section if you need further information. + +--- + +### 8. Adjusting Settings +[▶ View on Loom (2:14)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=134) +![Settings](https://loom.com/i/e61af08dc23441bb9a01b2bd743a8856?workflows_screenshot=true) +- Access settings to toggle dark mode and RPG mode. + +--- + +### 9. Using RPG Mode +[▶ View on Loom (2:24)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=144) +![RPG Mode](https://loom.com/i/0654dd02fe13475a8d2e2db02f3bd716?workflows_screenshot=true) +- Enable RPG mode to gamify task completion. +- Earn energy points for completed tasks. + +--- + +### 10. Accessing the Journal +[▶ View on Loom (2:49)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=169) +![Journal](https://loom.com/i/714aa35fbe83482899c22e918f3428fc?workflows_screenshot=true) +- Click on the journal to view daily stories and discoveries. + +--- + +### 11. Managing Personal To-Do List +[▶ View on Loom (3:41)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=221) +![Personal Tasks](https://loom.com/i/2c88688e90074ba9b36cd5de89717450?workflows_screenshot=true) +- Add personal tasks that do not count for points. +- Mark them as complete when done. + +--- + +### 12. Adding New Tasks +[▶ View on Loom (4:40)](https://loom.com/share/973fe7d1ed644806badf084b4e45a908?t=280) +![Adding Tasks](https://loom.com/i/a44e3c34aae34125aaa88181de32b5e3?workflows_screenshot=true) +- Click **Add New Task** to create a task not assigned to you. +- Select the appropriate template or fill in the details. + +--- + +### ⚠ Cautionary Notes +- Check tasks daily to avoid backlog. +- Be mindful of urgency levels to prioritize effectively. + +### 💡 Tips for Efficiency +- Regularly review **Waiting On** tasks to follow up as needed. +- Use the journal to track progress and insights from completed tasks. + +--- + +**📹 Full Loom Walkthrough:** +