Skip to content

Commit 52d1b41

Browse files
committed
feat: some more docs
1 parent ceee77e commit 52d1b41

File tree

5 files changed

+6
-53
lines changed

5 files changed

+6
-53
lines changed

docs/notificator-collaboration.md

Lines changed: 6 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -13,80 +13,33 @@ No more "are you looking at this?" messages in Slack!
1313
### User Authentication
1414
Everyone gets their own login. No more anonymous alert handling!
1515

16-
![User Login](screenshots/user-login.png)
16+
![User Registration](../screenshots/user-registration.png)
17+
*Screenshot: Registration dialog with username/password fields*
18+
19+
![User Login](../screenshots/user-login.png)
1720
*Screenshot: Login dialog with username/password fields*
1821

1922
### Alert Acknowledgments
2023
Click "Ack" on any alert to let your team know you're handling it. The alert gets marked with your name and timestamp.
2124

22-
![Alert Acknowledgment](screenshots/alert-ack.png)
25+
![Alert Acknowledgment](../screenshots/alert-ack.png)
2326
*Screenshot: Alert with acknowledge button and "Acked by Bastien at 14:32" status*
2427

2528
### Comments on Alerts
2629
Add context to alerts! Leave notes about what you're investigating, what you found, or what actions you took.
2730

28-
![Alert Comments](screenshots/alert-comments.png)
31+
![Alert Comments](../screenshots/alert-comments.png)
2932
*Screenshot: Alert with comment section showing conversation between team members*
3033

31-
### Real-time Updates
32-
When someone acks an alert or adds a comment, everyone sees it instantly. No refresh needed!
33-
34-
![Real-time Updates](screenshots/real-time-updates.png)
35-
*Screenshot: Alert status changing in real-time as someone else acknowledges it*
36-
3734
### Team Filters
3835
Filter alerts by acknowledgment status to quickly see what needs attention:
3936
- Show only unacknowledged alerts
4037
- Show only my acknowledged alerts
4138
- Show alerts with comments
4239

43-
![Team Filters](screenshots/team-filters.png)
44-
*Screenshot: Filter dropdown with acknowledgment and comment options*
45-
4640
### Alert History
4741
See the full timeline of what happened with each alert - when it fired, who acknowledged it, what comments were added.
4842

49-
![Alert History](screenshots/alert-history.png)
50-
*Screenshot: Alert detail view showing chronological history of actions*
51-
52-
### 3. Create user accounts
53-
54-
The first time someone connects, they can register a new account. After that, they just login with their username/password.
55-
56-
![User Registration](screenshots/user-registration.png)
57-
*Screenshot: Registration form for new users*
58-
59-
## How it works in practice
60-
61-
### During an incident
62-
1. **Alert fires** - Everyone sees it immediately
63-
2. **Someone acknowledges** - "I'm on it!" (everyone else can relax)
64-
3. **Investigation starts** - Add comments as you dig in
65-
4. **Share findings** - "Found the issue, deploying fix"
66-
5. **Resolution** - "Fixed! Was a database connection leak"
67-
68-
### Daily operations
69-
- **Morning standup**: Check acknowledged alerts from night shift
70-
- **Handoffs**: See what the previous shift was working on
71-
- **Knowledge sharing**: Comments become a searchable history
72-
73-
## Best practices
74-
75-
### Acknowledgment etiquette
76-
- **Ack quickly** when you start looking at an alert
77-
- **Add a comment** saying what you're investigating
78-
- **Update status** as you progress ("still investigating", "fix deployed", etc.)
79-
80-
### Writing good comments
81-
- **Be specific**: "CPU spike on web-01" not just "investigating"
82-
- **Include actions**: "Restarted service, monitoring for 10 minutes"
83-
- **Share findings**: "Caused by memory leak in feature X"
84-
85-
### Team workflow
86-
- **Ack before investigating** - prevents duplicate work
87-
- **Comment your findings** - helps others learn
88-
- **Don't unack others** - unless they ask you to take over
89-
9043
## Troubleshooting
9144

9245
### "Can't connect to backend"

screenshots/alert-ack.png

237 KB
Loading

screenshots/alert-comments.png

259 KB
Loading

screenshots/user-login.png

37.2 KB
Loading

screenshots/user-registration.png

44.2 KB
Loading

0 commit comments

Comments
 (0)