Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
fd6827f
feat(utils): add simple autosave utilities for debouncing and undo fu…
AlexVOiceover Sep 22, 2025
92464a9
feat(ui): add SaveStatus and UndoButton components for autosave feature
AlexVOiceover Sep 22, 2025
de9125f
feat(privacy): implement autosave for privacy toggle with visual feed…
AlexVOiceover Sep 22, 2025
305fa2e
feat(answer): implement undo functionality for response text with key…
AlexVOiceover Sep 22, 2025
d331fb9
feat(answer): add OK button with smart change detection and improve u…
AlexVOiceover Sep 22, 2025
d79541c
refactor(ui): remove submit buttons and clean up unused autosave code
AlexVOiceover Sep 23, 2025
10e4944
feat(actions): simplify actions system by removing versioning
AlexVOiceover Sep 23, 2025
2805304
fix(cascade-deletion): properly delete response and all associated ac…
AlexVOiceover Sep 23, 2025
4208a1d
feat(navigation): make logo clickable to navigate to dashboard
AlexVOiceover Sep 23, 2025
cd159d9
feat(ui): improve header layout and move font control to footer
AlexVOiceover Sep 23, 2025
ee464f3
feat(ui): implement responsive design improvements and container queries
AlexVOiceover Sep 23, 2025
82199eb
refactor(header): simplify structure and CSS classes
AlexVOiceover Sep 23, 2025
d24bfdc
feat(mobile): implement comprehensive responsive design improvements
AlexVOiceover Sep 23, 2025
2a4de7a
style(actions): standardize button colors for edit and delete actions
AlexVOiceover Sep 23, 2025
4cb0470
feat(security): implement row level security and fix data integrity i…
AlexVOiceover Sep 23, 2025
fce98dd
fix(deps): remove duplicate vite dependency from package.json
AlexVOiceover Sep 23, 2025
303a79a
fix(types): resolve TypeScript error in QuestionCard response ID assi…
AlexVOiceover Sep 23, 2025
bebbef0
fix(ux): prevent duplicate responses and improve UI state management
AlexVOiceover Sep 23, 2025
386d150
refactor(responses): remove versioning system and simplify response m…
AlexVOiceover Sep 23, 2025
a2aff2f
perf(ui): optimize deletion and fix privacy toggle layout shift
AlexVOiceover Sep 24, 2025
6abdc7b
feat(security): add XSS protection to email preview component
AlexVOiceover Sep 24, 2025
cdd6e9d
feat(validation): prevent saving empty responses with auto-restore
AlexVOiceover Sep 24, 2025
ab32994
feat(navigation): implement clickable actions with proper breadcrumb …
AlexVOiceover Sep 24, 2025
7653035
fix(accessibility): correct label association in privacy toggle
AlexVOiceover Sep 24, 2025
74fc5f7
fix(database): remove version field from production seeding script
AlexVOiceover Sep 24, 2025
083b9ae
feat(email): add custom notes input to email preview
AlexVOiceover Sep 24, 2025
55a7605
fix(ui): implement optimistic update with rollback for privacy toggle
AlexVOiceover Sep 24, 2025
70bf674
chore: remove debug console.log statements from production code
AlexVOiceover Sep 24, 2025
a9bffe1
feat(email): add line manager name and email to email preview
AlexVOiceover Sep 25, 2025
1322709
refactor(email): move manager contact info to top of email
AlexVOiceover Sep 25, 2025
3118529
style(email): add visual styling to manager contact info
AlexVOiceover Sep 25, 2025
8659ad7
chore: bump version to 0.6.009
AlexVOiceover Oct 18, 2025
c18e225
chore: bump version to 0.6.010
AlexVOiceover Oct 18, 2025
24cab41
chore: bump version to 0.6.011
AlexVOiceover Oct 18, 2025
805a9ee
chore: bump version to 0.6.012
AlexVOiceover Oct 18, 2025
85e1366
style(ui): improve modal styling and mobile responsiveness
AlexVOiceover Oct 18, 2025
829c8de
chore: bump version to 0.6.013
AlexVOiceover Oct 18, 2025
3c300fe
docs(help): add user tutorial and improve contextual help system
AlexVOiceover Oct 18, 2025
f353141
style(ui): improve dashboard spacing and modal UX
AlexVOiceover Oct 19, 2025
e18bc26
feat(ui): implement progress indicator with visual completion pie charts
AlexVOiceover Oct 19, 2025
ef8c904
chore: bump version to 0.6.014
AlexVOiceover Oct 19, 2025
a88dc0f
chore: bump version to 0.6.015
AlexVOiceover Oct 19, 2025
28d3809
chore: bump version to 0.6.016
AlexVOiceover Oct 19, 2025
2e8beca
chore: bump version to 0.6.017
AlexVOiceover Oct 20, 2025
56ba419
chore: bump version to 0.6.018
AlexVOiceover Oct 20, 2025
4eed4ae
chore: bump version to 0.6.019
AlexVOiceover Oct 20, 2025
4d4b21b
chore: bump version to 0.6.020
AlexVOiceover Oct 20, 2025
2c091dc
chore: bump version to 0.6.021
AlexVOiceover Oct 20, 2025
489856f
chore: bump version to 0.6.022
AlexVOiceover Oct 20, 2025
53e7666
chore: bump version to 0.6.023
AlexVOiceover Oct 20, 2025
78d45fe
fix(ui): improve modal mobile responsiveness and email button focus
AlexVOiceover Oct 20, 2025
98f87c9
chore: bump version to 0.6.024
AlexVOiceover Oct 20, 2025
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
285 changes: 285 additions & 0 deletions TUTORIAL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,285 @@
# Workwise User Guide

**Your Digital Workplace Passport**

---

## Table of Contents

1. [Getting Started](#getting-started)
2. [Dashboard Overview](#dashboard-overview)
3. [Managing Your Responses](#managing-your-responses)
4. [Working with Categories](#working-with-categories)
5. [Managing Actions](#managing-actions)
6. [Accessing Resources](#accessing-resources)
7. [Sharing Your Workplace Passport](#sharing-your-workplace-passport)
8. [Privacy and Control](#privacy-and-control)

---

## Getting Started

### Welcome to Workwise

Your Digital Workplace Passport helps you document and share your workplace needs with your line manager, promoting a more inclusive work environment.

<p align="center">
<img src="static/help/screenshots/dashboard-no-profile.png" alt="Dashboard showing profile selection dropdown" width="400">
</p>

<p align="center"><em>Select your profile to get started</em></p>


### First Steps

To begin using your workplace passport:

1. **Sign in or create an account** - Enter your email address to receive a magic link for secure, password-free authentication
2. **Check your email** - Click the magic link sent to your inbox to access your account
3. **Select your profile** from the dropdown menu (if you have multiple profiles)
4. **Explore the dashboard** - organized into three sections: Actions, Categories, and Resources
5. **Click on any category tile** to start adding your responses
6. **Use the email button** in the header to share your responses with your line manager
7. **Access help anytime** by clicking the 'i' button in the footer

---

## Dashboard Overview

### Understanding Your Dashboard

Your dashboard is organized into three main sections: **Actions** (personal plans), **Categories** (workplace topics), and **Resources** (support materials). Each section contains tiles that allow you to navigate to specific areas.

<p align="center">
<img src="static/help/screenshots/dashboard-with-profile.png" alt="Dashboard with three sections showing Actions, Categories, and Resources" width="400">
</p>

<p align="center"><em>Dashboard showing Actions, Categories, and Resources sections</em></p>


### Navigating the Dashboard

#### Actions Section
View and manage your personal action items that help you address workplace challenges.

#### Categories Section
Click category tiles to explore questions and add responses about your workplace needs and preferences.

#### Resources Section
Access helpful workplace support materials and external links.

### Dashboard Controls

- **Email button** (in header): Share your public responses with your line manager
- **Help button** (in footer): Access context-sensitive help for your current view
- **Font size control** (in footer): Adjust text size for comfortable reading
- **Terms and Privacy** (in footer): Review terms of use and privacy policy

---

## Managing Your Responses

### About Responses

Your responses document your workplace needs, preferences, and experiences. You have full control over what you share and with whom. Access your responses by clicking on a question from any category.

<p align="center">
<img src="static/help/screenshots/response-editing.png" alt="Response editing interface showing privacy controls and action buttons" width="400">
</p>

<p align="center"><em>Edit responses and control their visibility</em></p>


### Response Options

When viewing a question, you can:

- **Provide a detailed response** explaining your needs or preferences
- **Mark the question as 'Not Applicable'** if it doesn't apply to you
- **Skip the question** to answer it later
- **Edit or update your response** anytime
- **Delete your response** if you no longer want it saved

### Response Privacy

You control the visibility of each response:

- **Public responses** can be shared with your line manager via email
- **Private responses** remain confidential to you
- **Change visibility settings** anytime using the toggle
- **Only you decide** what information to share
- **Your privacy is always protected**

### Creating Actions from Responses

Once you've provided a response, you can create personal action items to address workplace challenges:

- **Actions can only be created after you've answered a question**
- Click **'Add Action'** to create a personal plan linked to this question
- **Edit or delete actions** anytime to track your progress
- Set actions as **Active/Inactive** to show current priorities
- **Control action visibility** (public/private) to decide what to share
- **Public actions appear in emails** to your line manager

### Navigation

Use the **Back button** in the header to return to the previous view. Your changes are saved automatically as you work.

---

## Working with Categories

### Exploring Categories

Categories group related workplace topics and questions. Each category contains questions you can respond to about your workplace needs and preferences. Click any category tile from the Categories section on your dashboard to begin.

<p align="center">
<img src="static/help/screenshots/categories-overview.png" alt="Category view showing available questions with status indicators" width="400">
</p>

<p align="center"><em>Questions within a category - checkmark shows answered, question mark shows needs attention</em></p>


### Understanding Question Status

- **Question mark (?)** - Questions that require your attention
- **Checkmark (✓)** - Questions that are already answered or skipped

### Responding to Questions

When exploring categories:

1. Click on any question to add or edit your response
2. Provide detailed, honest responses about your needs
3. Set response visibility (public/private)
4. Navigate back using the **Back button** in the header

---

## Managing Actions

### About Actions

Actions are personal plans you create to help address workplace challenges. Each action is linked to a question from your workplace passport and can be shared with your line manager.

<p align="center">
<img src="static/help/screenshots/actions-list.png" alt="Actions list showing action items with status toggles and link icons" width="400">
</p>

<p align="center"><em>Your personal actions list with Active/Inactive toggles</em></p>


### Working with Actions

You can manage your actions in several ways:

- **Toggle between Active and Inactive status** for each action
- **Click the link icon** to view the related question
- **Use 'Show inactive' toggle** to see archived actions
- **Set actions as public/private** to control sharing
- **Navigate back to the dashboard** using the Back button in the header

### Sharing Actions

Public actions can be included in emails to your line manager, helping them understand your proactive approach to workplace challenges.

---

## Accessing Resources

### Available Resources

Resources are helpful materials, links, and information related to workplace support and neurodivergent needs. Access them from the Resources section on your dashboard.

<p align="center">
<img src="static/help/screenshots/resources-view.png" alt="Resources page showing available support materials with clickable links" width="400">
</p>

<p align="center"><em>Browse available workplace support resources</em></p>


### Using Resources

Resources can help you:

- Learn about workplace accommodations
- Find support materials for specific challenges
- Access external links and tools (click the URL to open in a new tab)
- Discover best practices for workplace inclusion
- Get guidance on communicating your needs
- Navigate back to the dashboard using the **Back button** in the header

---

## Sharing Your Workplace Passport

### Email Preview

The email preview shows a summary of your public responses and actions that can be shared with your line manager. Access it by clicking the email button in the header.

<p align="center">
<img src="static/help/screenshots/email-preview.png" alt="Email preview showing formatted workplace passport summary with send button" width="400">
</p>

<p align="center"><em>Preview your workplace passport before sharing</em></p>


### Before Sending

Review the email content carefully:

- ✓ Check that all information accurately represents your needs
- ✓ Verify only public responses and actions are included
- ✓ There's an optional notes field at the bottom for additional context - use this sparingly since the app is designed to track everything through questions, responses, and actions
- ✓ Remember you control when and what to share
- ✓ Use the **Back button** in the header to return to the dashboard without sending

### Sending the Email

When you're ready, enter your line manager's email address and click send. The email will be sent with a professional summary of your workplace passport, helping facilitate productive conversations about your needs.

---

## Privacy and Control

### Your Data, Your Choice

Workwise puts you in complete control of your workplace passport:

- **All responses start as private** - nothing is shared unless you explicitly make it public
- **Change visibility anytime** - toggle between public and private for any response or action
- **Delete freely** - remove any response or action you no longer want
- **Preview before sending** - always see exactly what will be shared
- **No automatic sharing** - emails are only sent when you click send

### Data Storage

Your workplace passport data is securely stored and only accessible to you. When you share your passport via email, only the items marked as "public" are included in the email to your line manager.

### Getting Help

Access context-sensitive help anytime by clicking the **'i' button** in the footer. The help content will adapt based on what you're currently viewing in the application.

---

## Tips for Success

### Getting the Most from Your Workplace Passport

1. **Be honest and specific** - The more detailed your responses, the better your line manager can support you
2. **Start small** - You don't need to answer everything at once. Focus on the most relevant categories first
3. **Review regularly** - Your needs may change over time. Update your responses as needed
4. **Use actions strategically** - Create actions for challenges you're actively working to address
5. **Control your narrative** - Use the public/private settings to share what feels comfortable
6. **Preview before sharing** - Always review the email preview to ensure you're comfortable with what's being shared

### Need More Help?

- Click the **'i' button** in the footer for context-specific help
- Review the **Terms of Use** and **Privacy Policy** in the footer
- Adjust **font size** in the footer for comfortable reading
- Use the **Back button** to navigate between views

---

*Generated with Workwise - Your Digital Workplace Passport*
Loading