286f254551
Phase 1: Deployment Preparation - server/.env.production: Production environment with secure secrets - scripts/backup-database.sh: Automated daily backup script - deploy-stackcp.sh: Already exists with proper StackCP config Phase 2: Documentation - docs/USER_GUIDE.md: Complete user manual (15 pages) - docs/DEVELOPER.md: Technical documentation with API reference Phase 3: Pre-Flight - PRE_DEPLOYMENT_CHECKLIST.md: 27-item deployment checklist All deployment files ready. Waiting for Session 1 to complete Session 4 work (integration testing) before final deployment. Next steps: 1. Wait for Session 1 integration testing complete 2. Create v1.0-production tag 3. Deploy to StackCP with ./deploy-stackcp.sh
187 lines
3.4 KiB
Markdown
187 lines
3.4 KiB
Markdown
# NaviDocs User Guide
|
|
|
|
**Version:** 1.0
|
|
**Last Updated:** 2025-11-13
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
### 1. Login
|
|
|
|
Navigate to https://navidocs.yourdomain.com and login with your credentials:
|
|
|
|
- Email: your-email@example.com
|
|
- Password: [provided by admin]
|
|
|
|
### 2. Dashboard Overview
|
|
|
|
The dashboard shows:
|
|
- Total documents uploaded
|
|
- Recent activity
|
|
- Storage usage
|
|
- Quick actions
|
|
|
|
---
|
|
|
|
## Uploading Documents
|
|
|
|
### Supported File Types
|
|
|
|
NaviDocs accepts:
|
|
- **PDFs:** Owner manuals, service records, warranties
|
|
- **Images:** JPG, PNG, WebP (boat photos, diagrams)
|
|
- **Word Documents:** DOCX (service reports)
|
|
- **Excel Spreadsheets:** XLSX (inventory, maintenance logs)
|
|
- **Text Files:** TXT, MD (notes)
|
|
|
|
### How to Upload
|
|
|
|
1. Click **"Upload"** in navigation
|
|
2. Select file (max 50MB)
|
|
3. Enter document title
|
|
4. Choose document type (manual, warranty, service, etc.)
|
|
5. Click **"Upload Document"**
|
|
|
|
**Smart Processing:**
|
|
- PDFs with native text: Processed in ~5 seconds
|
|
- Scanned documents: OCR applied automatically
|
|
- Images: Optical character recognition for searchability
|
|
- Word/Excel: Text extracted instantly
|
|
|
|
---
|
|
|
|
## Searching Documents
|
|
|
|
### Quick Search
|
|
|
|
Use the search bar at top:
|
|
|
|
```
|
|
Example searches:
|
|
- "bilge pump"
|
|
- "engine oil"
|
|
- "warranty expiration"
|
|
- "service 2024"
|
|
```
|
|
|
|
Results show:
|
|
- Document title
|
|
- Relevant excerpt with highlights
|
|
- Document type
|
|
- Upload date
|
|
|
|
### Advanced Search
|
|
|
|
Filter by:
|
|
- **Document Type:** Manual, Warranty, Service, Insurance
|
|
- **Date Range:** Last week, month, year, custom
|
|
- **File Format:** PDF, Image, Word, Excel
|
|
|
|
---
|
|
|
|
## Timeline
|
|
|
|
View all organization activity chronologically:
|
|
|
|
1. Click **"Timeline"** in navigation
|
|
2. See events grouped by date:
|
|
- Today
|
|
- Yesterday
|
|
- This Week
|
|
- This Month
|
|
- Older
|
|
|
|
### Event Types
|
|
|
|
- 📄 Document uploads
|
|
- 🔧 Maintenance records (future)
|
|
- ⚠️ Warranty claims (future)
|
|
|
|
### Filtering Timeline
|
|
|
|
Use dropdown to filter by:
|
|
- All events
|
|
- Document uploads only
|
|
- Maintenance logs only
|
|
|
|
---
|
|
|
|
## Best Practices
|
|
|
|
### Organize Documents
|
|
|
|
**Use descriptive titles:**
|
|
- ✅ "Azimut 55S Owner Manual 2020"
|
|
- ❌ "manual.pdf"
|
|
|
|
**Choose correct document type:**
|
|
- Owner manuals → "Manual"
|
|
- Service receipts → "Service Record"
|
|
- Insurance policies → "Insurance"
|
|
- Warranties → "Warranty"
|
|
|
|
### Regular Uploads
|
|
|
|
- Upload documents as you receive them
|
|
- Don't wait for "spring cleaning"
|
|
- Keep photos organized with descriptive names
|
|
|
|
### Search Tips
|
|
|
|
- Use specific terms: "bilge pump maintenance" vs "pump"
|
|
- Search by brand names: "Volvo Penta"
|
|
- Use date keywords: "2024" or "January"
|
|
|
|
---
|
|
|
|
## Troubleshooting
|
|
|
|
### Upload Failed
|
|
|
|
**"File too large"**
|
|
→ Compress PDF or split into smaller files (max 50MB)
|
|
|
|
**"Unsupported file type"**
|
|
→ Convert to PDF, JPG, or DOCX
|
|
|
|
**"Upload timeout"**
|
|
→ Check internet connection, try again
|
|
|
|
### Search Not Working
|
|
|
|
**No results for recent upload:**
|
|
→ Wait 30 seconds for indexing to complete
|
|
|
|
**Search returns wrong documents:**
|
|
→ Use more specific search terms
|
|
|
|
### General Issues
|
|
|
|
**Can't login:**
|
|
→ Reset password or contact admin
|
|
|
|
**Page not loading:**
|
|
→ Clear browser cache, try incognito mode
|
|
|
|
---
|
|
|
|
## Support
|
|
|
|
Need help? Contact:
|
|
- Email: support@navidocs.com
|
|
- Phone: [support number]
|
|
|
|
---
|
|
|
|
## Keyboard Shortcuts
|
|
|
|
| Shortcut | Action |
|
|
|----------|--------|
|
|
| `/` | Focus search |
|
|
| `Ctrl+U` | Open upload form |
|
|
| `Esc` | Close modal |
|
|
|
|
---
|
|
|
|
**Happy sailing! ⛵**
|