Skip to content

Commit f05af4e

Browse files
Needed to merge to main due to Vercel API being down. I need to trigger manually deployment
Lots of things here AWS was having issues -> Vercel API is down Need to merge to main to trigger automatic deployment
2 parents 785640d + 1c48265 commit f05af4e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+4709
-2705
lines changed

TUTORIAL.md

Lines changed: 285 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,285 @@
1+
# Workwise User Guide
2+
3+
**Your Digital Workplace Passport**
4+
5+
---
6+
7+
## Table of Contents
8+
9+
1. [Getting Started](#getting-started)
10+
2. [Dashboard Overview](#dashboard-overview)
11+
3. [Managing Your Responses](#managing-your-responses)
12+
4. [Working with Categories](#working-with-categories)
13+
5. [Managing Actions](#managing-actions)
14+
6. [Accessing Resources](#accessing-resources)
15+
7. [Sharing Your Workplace Passport](#sharing-your-workplace-passport)
16+
8. [Privacy and Control](#privacy-and-control)
17+
18+
---
19+
20+
## Getting Started
21+
22+
### Welcome to Workwise
23+
24+
Your Digital Workplace Passport helps you document and share your workplace needs with your line manager, promoting a more inclusive work environment.
25+
26+
<p align="center">
27+
<img src="static/help/screenshots/dashboard-no-profile.png" alt="Dashboard showing profile selection dropdown" width="400">
28+
</p>
29+
30+
<p align="center"><em>Select your profile to get started</em></p>
31+
32+
33+
### First Steps
34+
35+
To begin using your workplace passport:
36+
37+
1. **Sign in or create an account** - Enter your email address to receive a magic link for secure, password-free authentication
38+
2. **Check your email** - Click the magic link sent to your inbox to access your account
39+
3. **Select your profile** from the dropdown menu (if you have multiple profiles)
40+
4. **Explore the dashboard** - organized into three sections: Actions, Categories, and Resources
41+
5. **Click on any category tile** to start adding your responses
42+
6. **Use the email button** in the header to share your responses with your line manager
43+
7. **Access help anytime** by clicking the 'i' button in the footer
44+
45+
---
46+
47+
## Dashboard Overview
48+
49+
### Understanding Your Dashboard
50+
51+
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.
52+
53+
<p align="center">
54+
<img src="static/help/screenshots/dashboard-with-profile.png" alt="Dashboard with three sections showing Actions, Categories, and Resources" width="400">
55+
</p>
56+
57+
<p align="center"><em>Dashboard showing Actions, Categories, and Resources sections</em></p>
58+
59+
60+
### Navigating the Dashboard
61+
62+
#### Actions Section
63+
View and manage your personal action items that help you address workplace challenges.
64+
65+
#### Categories Section
66+
Click category tiles to explore questions and add responses about your workplace needs and preferences.
67+
68+
#### Resources Section
69+
Access helpful workplace support materials and external links.
70+
71+
### Dashboard Controls
72+
73+
- **Email button** (in header): Share your public responses with your line manager
74+
- **Help button** (in footer): Access context-sensitive help for your current view
75+
- **Font size control** (in footer): Adjust text size for comfortable reading
76+
- **Terms and Privacy** (in footer): Review terms of use and privacy policy
77+
78+
---
79+
80+
## Managing Your Responses
81+
82+
### About Responses
83+
84+
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.
85+
86+
<p align="center">
87+
<img src="static/help/screenshots/response-editing.png" alt="Response editing interface showing privacy controls and action buttons" width="400">
88+
</p>
89+
90+
<p align="center"><em>Edit responses and control their visibility</em></p>
91+
92+
93+
### Response Options
94+
95+
When viewing a question, you can:
96+
97+
- **Provide a detailed response** explaining your needs or preferences
98+
- **Mark the question as 'Not Applicable'** if it doesn't apply to you
99+
- **Skip the question** to answer it later
100+
- **Edit or update your response** anytime
101+
- **Delete your response** if you no longer want it saved
102+
103+
### Response Privacy
104+
105+
You control the visibility of each response:
106+
107+
- **Public responses** can be shared with your line manager via email
108+
- **Private responses** remain confidential to you
109+
- **Change visibility settings** anytime using the toggle
110+
- **Only you decide** what information to share
111+
- **Your privacy is always protected**
112+
113+
### Creating Actions from Responses
114+
115+
Once you've provided a response, you can create personal action items to address workplace challenges:
116+
117+
- **Actions can only be created after you've answered a question**
118+
- Click **'Add Action'** to create a personal plan linked to this question
119+
- **Edit or delete actions** anytime to track your progress
120+
- Set actions as **Active/Inactive** to show current priorities
121+
- **Control action visibility** (public/private) to decide what to share
122+
- **Public actions appear in emails** to your line manager
123+
124+
### Navigation
125+
126+
Use the **Back button** in the header to return to the previous view. Your changes are saved automatically as you work.
127+
128+
---
129+
130+
## Working with Categories
131+
132+
### Exploring Categories
133+
134+
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.
135+
136+
<p align="center">
137+
<img src="static/help/screenshots/categories-overview.png" alt="Category view showing available questions with status indicators" width="400">
138+
</p>
139+
140+
<p align="center"><em>Questions within a category - checkmark shows answered, question mark shows needs attention</em></p>
141+
142+
143+
### Understanding Question Status
144+
145+
- **Question mark (?)** - Questions that require your attention
146+
- **Checkmark (✓)** - Questions that are already answered or skipped
147+
148+
### Responding to Questions
149+
150+
When exploring categories:
151+
152+
1. Click on any question to add or edit your response
153+
2. Provide detailed, honest responses about your needs
154+
3. Set response visibility (public/private)
155+
4. Navigate back using the **Back button** in the header
156+
157+
---
158+
159+
## Managing Actions
160+
161+
### About Actions
162+
163+
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.
164+
165+
<p align="center">
166+
<img src="static/help/screenshots/actions-list.png" alt="Actions list showing action items with status toggles and link icons" width="400">
167+
</p>
168+
169+
<p align="center"><em>Your personal actions list with Active/Inactive toggles</em></p>
170+
171+
172+
### Working with Actions
173+
174+
You can manage your actions in several ways:
175+
176+
- **Toggle between Active and Inactive status** for each action
177+
- **Click the link icon** to view the related question
178+
- **Use 'Show inactive' toggle** to see archived actions
179+
- **Set actions as public/private** to control sharing
180+
- **Navigate back to the dashboard** using the Back button in the header
181+
182+
### Sharing Actions
183+
184+
Public actions can be included in emails to your line manager, helping them understand your proactive approach to workplace challenges.
185+
186+
---
187+
188+
## Accessing Resources
189+
190+
### Available Resources
191+
192+
Resources are helpful materials, links, and information related to workplace support and neurodivergent needs. Access them from the Resources section on your dashboard.
193+
194+
<p align="center">
195+
<img src="static/help/screenshots/resources-view.png" alt="Resources page showing available support materials with clickable links" width="400">
196+
</p>
197+
198+
<p align="center"><em>Browse available workplace support resources</em></p>
199+
200+
201+
### Using Resources
202+
203+
Resources can help you:
204+
205+
- Learn about workplace accommodations
206+
- Find support materials for specific challenges
207+
- Access external links and tools (click the URL to open in a new tab)
208+
- Discover best practices for workplace inclusion
209+
- Get guidance on communicating your needs
210+
- Navigate back to the dashboard using the **Back button** in the header
211+
212+
---
213+
214+
## Sharing Your Workplace Passport
215+
216+
### Email Preview
217+
218+
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.
219+
220+
<p align="center">
221+
<img src="static/help/screenshots/email-preview.png" alt="Email preview showing formatted workplace passport summary with send button" width="400">
222+
</p>
223+
224+
<p align="center"><em>Preview your workplace passport before sharing</em></p>
225+
226+
227+
### Before Sending
228+
229+
Review the email content carefully:
230+
231+
- ✓ Check that all information accurately represents your needs
232+
- ✓ Verify only public responses and actions are included
233+
- ✓ 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
234+
- ✓ Remember you control when and what to share
235+
- ✓ Use the **Back button** in the header to return to the dashboard without sending
236+
237+
### Sending the Email
238+
239+
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.
240+
241+
---
242+
243+
## Privacy and Control
244+
245+
### Your Data, Your Choice
246+
247+
Workwise puts you in complete control of your workplace passport:
248+
249+
- **All responses start as private** - nothing is shared unless you explicitly make it public
250+
- **Change visibility anytime** - toggle between public and private for any response or action
251+
- **Delete freely** - remove any response or action you no longer want
252+
- **Preview before sending** - always see exactly what will be shared
253+
- **No automatic sharing** - emails are only sent when you click send
254+
255+
### Data Storage
256+
257+
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.
258+
259+
### Getting Help
260+
261+
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.
262+
263+
---
264+
265+
## Tips for Success
266+
267+
### Getting the Most from Your Workplace Passport
268+
269+
1. **Be honest and specific** - The more detailed your responses, the better your line manager can support you
270+
2. **Start small** - You don't need to answer everything at once. Focus on the most relevant categories first
271+
3. **Review regularly** - Your needs may change over time. Update your responses as needed
272+
4. **Use actions strategically** - Create actions for challenges you're actively working to address
273+
5. **Control your narrative** - Use the public/private settings to share what feels comfortable
274+
6. **Preview before sharing** - Always review the email preview to ensure you're comfortable with what's being shared
275+
276+
### Need More Help?
277+
278+
- Click the **'i' button** in the footer for context-specific help
279+
- Review the **Terms of Use** and **Privacy Policy** in the footer
280+
- Adjust **font size** in the footer for comfortable reading
281+
- Use the **Back button** to navigate between views
282+
283+
---
284+
285+
*Generated with Workwise - Your Digital Workplace Passport*

0 commit comments

Comments
 (0)