Welcome! Find what you need based on what you're trying to do.
| I want to... | Start here |
|---|---|
| Get quick help with a task | Help — in-app help and quick reference |
| Understand what KoNote is | README — overview, features, tech stack |
| Understand the design philosophy | Design Principles — research-based approach to participant engagement |
| Set up KoNote for the first time | Deploying KoNote — local setup, cloud hosting |
| Configure my agency's settings | Admin Guide — terminology, programs, users, backups |
| Learn how to use KoNote daily | Using KoNote — staff training guide |
| Understand the technical architecture | Technical Reference — data models, security, APIs |
See the Changelog for a full history of changes, including the latest release notes.
- Help & Quick Reference — find answers fast
- Surveys (Staff) — assigning surveys and entering responses
- Surveys (Admin) — creating surveys, trigger rules, shareable links
- Keyboard Shortcuts
- Troubleshooting
- Privacy Policy Template — customise before going live
- Admin Guide Index — all admin topics in one place
- Getting Started — first admin account, instance settings, setup wizard
- Features & Modules — feature toggles, programs, templates, metrics
- Surveys (Admin) — creating surveys, trigger rules, shareable links
- Terminology — customise the words used throughout the system
- Users & Roles — creating accounts, assigning roles, PM admin
- Portal — participant portal setup, invitations, MFA
- Messaging — SMS/email config, reminders, health monitoring
- Reporting — report templates, weekly export summary
- Security — encryption, audit logs, backup & restore
- Export Operations — managing exports and download links
- Confidential Programs & Matching — sensitive program isolation and duplicate detection
- Security Operations (detailed) — encryption, audit logging, erasure, export controls
- Finding Clients
- Writing Progress Notes
- Recording Events
- Logging Communications
- Staff Messaging — leave and read messages about participants
- Surveys — assigning and entering survey responses
- Client Transfer — move participants between programs
- Scheduling Meetings
- Using the Calendar Feed
- Viewing Plans
| Document | Audience | Purpose |
|---|---|---|
| Help | All users | Quick reference and in-app help |
| Surveys (Staff) | Staff | Assigning surveys and entering responses |
| Surveys (Admin) | Admins / PMs | Creating surveys, trigger rules, shareable links |
| Design Principles | All users | Research-based approach to participant-centred practice |
| Deploying KoNote | IT / Technical lead | Get KoNote running (local or cloud) |
| Privacy Policy Template | Admins / Legal | Customise for your organisation before going live |
| Admin Guide | Program managers / Admins | Configure and maintain your instance |
| Confidential Programs | Program managers / Admins | Sensitive program isolation and duplicate matching |
| Using KoNote | Front-line staff | Day-to-day usage guide |
| Technical Reference | Developers | Architecture, data models, customisation |
- Documentation issues: Open an issue on GitHub
- Security vulnerabilities: See SECURITY.md