Skip to content

User Guides - Documentation Status

This directory contains comprehensive guides for using Notifer through the web dashboard and mobile app.

πŸ“Š Documentation Coverage Analysis

βœ… Complete Guides (Ready for Content)

The following guide templates have been created with comprehensive structure and placeholders:

  1. Account Setup βœ…
  2. Account creation (email/password + Google OAuth)
  3. Email verification flow
  4. First login and initial setup
  5. Security best practices
  6. Status: Template complete, needs review with actual UI

  7. Priority: HIGH - First user interaction

  8. Creating Topics βœ…

  9. Topic creation via web dashboard
  10. Public vs private comparison and recommendations
  11. Topic naming best practices
  12. Topic management and organization
  13. Status: Template complete, needs screenshots

  14. Priority: HIGH - Core functionality

  15. Topic Settings βœ…

  16. All topic settings tabs (General, Access Tokens, Subscribers, Notifications, Advanced)
  17. Access token creation and management
  18. Notification preferences configuration
  19. Message retention and rate limits
  20. Status: Template complete, needs verification with actual implementation

  21. Priority: HIGH - Essential for topic management

  22. User Settings βœ…

  23. Profile settings
  24. Security settings (password, sessions, 2FA)
  25. Notification preferences (desktop, mobile)
  26. API keys management
  27. Billing and subscription management
  28. Status: Template complete, needs UI verification

  29. Priority: MEDIUM - Users access after initial setup

  30. Dashboard Guide βœ…

  31. Dashboard navigation and layout
  32. Topic tabs (My Topics, Subscribed, Discover)
  33. Message feed and real-time updates
  34. Keyboard shortcuts
  35. Mobile dashboard differences
  36. Status: Template complete, needs screenshots

  37. Priority: HIGH - Primary interface

  38. Notifications Guide βœ…

  39. Desktop notifications (browser)
  40. Mobile push notifications
  41. In-app notifications
  42. Priority-based and tag-based filtering
  43. Status: Template complete, comprehensive

  44. Priority: HIGH - Core feature

  45. Mobile App Guide βœ…

  46. Installation (iOS & Android)
  47. First launch setup
  48. App navigation
  49. Push notification configuration
  50. Deep linking
  51. Status: Template complete, needs mobile app beta testing

  52. Priority: HIGH - Mobile users

  53. Troubleshooting Guide βœ…

  54. Common issues across all features
  55. Account, topic, publishing, notification issues
  56. Connection and authentication problems
  57. Performance issues
  58. Status: Template complete, needs real-world issue examples

  59. Priority: MEDIUM - Support resource

  60. FAQ βœ…

  61. General questions about Notifer
  62. Account, topics, publishing questions
  63. Authentication and security
  64. Pricing and billing
  65. Status: Template complete, comprehensive
  66. Priority: MEDIUM - Discovery and quick answers

πŸ“‹ Priority Recommendations

PHASE 1: Pre-Launch Critical (Complete before v1.0 launch)

These guides are essential for launch because they cover the basic user journey:

  1. Account Setup - First interaction ⭐⭐⭐
  2. Verify registration flow matches implementation
  3. Add screenshots of registration form
  4. Add screenshot of email verification
  5. Test Google OAuth flow

  6. Verify all Settings sections exist

  7. Creating Topics - Core feature ⭐⭐⭐

  8. Add screenshots of topic creation modal
  9. Verify public vs private UI differences
  10. Add screenshot of topic list

  11. Verify topic naming validation rules

  12. Dashboard Guide - Primary interface ⭐⭐⭐

  13. Add screenshots of all tabs (My Topics, Subscribed, Discover)
  14. Screenshot message feed
  15. Verify keyboard shortcuts work

  16. Test mobile responsive design

  17. Notifications Guide - Core feature ⭐⭐⭐

  18. Test desktop notification flow on all browsers
  19. Verify mobile push notification setup
  20. Test priority-based filtering
  21. Verify quiet hours feature exists

PHASE 2: Post-Launch Enhancement (Add during v1.0 operation)

These guides enhance user experience but aren't critical for launch:

  1. Topic Settings - Advanced users ⭐⭐
  2. Screenshot all settings tabs
  3. Verify access token creation flow

  4. Verify notification settings work

  5. User Settings - Account management ⭐⭐

  6. Screenshot all settings sections
  7. Verify API keys management UI
  8. Test billing integration (when ready)

  9. Verify profile edit flow

  10. Mobile App Guide - Mobile users ⭐⭐

  11. Update with actual App Store/Play Store links
  12. Screenshots from actual mobile app
  13. Test deep linking

  14. Verify all features exist in mobile app

  15. FAQ - Discovery ⭐

  16. Add based on real user questions
  17. Update with actual pricing from PRICING.md
  18. Add real-world examples

  19. Update links to match actual implementation

  20. Troubleshooting - Support ⭐

  21. Collect real issues from testing
  22. Add actual error messages
  23. Create based on support tickets
  24. Update with real solutions

πŸ”„ Next Actions

Immediate (Before Launch):

  1. Review with Actual Implementation
  2. Go through each guide step-by-step in production
  3. Verify all features mentioned actually exist

  4. Update any differences from templates

  5. Add Screenshots

  6. Screenshot each major UI component
  7. Annotate screenshots with callouts

  8. Use consistent browser/theme for screenshots

  9. Test All Flows

  10. Follow each guide as a new user would
  11. Note any confusion or missing steps

  12. Update guides with improvements

  13. Cross-Link Verification

  14. Ensure all internal links work
  15. Update any links to moved documentation
  16. Add "Next Steps" sections where missing

Post-Launch:

  1. User Feedback Integration
  2. Track which guides users visit most
  3. Identify missing information from support tickets

  4. Add FAQ entries from common questions

  5. Video Tutorials

  6. Create short video versions of key guides
  7. Embed in documentation

  8. Upload to YouTube for SEO

  9. Localization

  10. Translate to Polish (PL)
  11. Add language selector
  12. Maintain both EN and PL versions

πŸ“¦ Documentation Organization

docs/
β”œβ”€β”€ guides/                      # ← USER GUIDES (this directory)
β”‚   β”œβ”€β”€ account-setup.md        # Account creation and setup
β”‚   β”œβ”€β”€ creating-topics.md      # Topic creation guide
β”‚   β”œβ”€β”€ topic-settings.md       # Topic configuration
β”‚   β”œβ”€β”€ user-settings.md        # User preferences and account
β”‚   β”œβ”€β”€ dashboard.md            # Dashboard navigation
β”‚   β”œβ”€β”€ notifications.md        # Notification setup
β”‚   β”œβ”€β”€ mobile-app.md          # Mobile app guide
β”‚   β”œβ”€β”€ troubleshooting.md     # Problem solving
β”‚   └── faq.md                 # Frequently asked questions
β”œβ”€β”€ getting-started/            # Quick start guides
β”œβ”€β”€ publish/                    # Publishing methods (HTTP, CLI, SDKs)
β”œβ”€β”€ subscribe/                  # Subscription methods
β”œβ”€β”€ features/                   # Feature documentation
β”œβ”€β”€ api/                        # API reference
└── legal/                      # β†’ External: notifer.io/terms, notifer.io/privacy

docs-devops/                    # ← TECHNICAL DOCS (separate)
β”œβ”€β”€ ARCHITECTURE.md
β”œβ”€β”€ MAINTENANCE.md
β”œβ”€β”€ backend/
└── ... (technical documentation)

🎯 Content Quality Checklist

For each guide, ensure:

  • Accuracy: All steps match actual implementation
  • Completeness: No missing steps or prerequisites
  • Screenshots: Visual aids for complex UI
  • Examples: Real-world use cases
  • Cross-links: Related guides linked in "Next Steps"
  • Troubleshooting: Common issues addressed
  • Mobile-friendly: Readable on small screens
  • SEO: Good titles, headers, meta descriptions
  • Up-to-date: Review after each feature change

πŸ“ Template Standards

All guides follow this structure:

  1. Title - Clear, action-oriented (e.g., "Creating Topics", not "Topics")
  2. Introduction - Quick tip box, what this guide covers
  3. Main Content - Step-by-step instructions with screenshots
  4. Examples - Real-world use cases
  5. Troubleshooting - Common issues and solutions
  6. Next Steps - Links to related guides

Formatting Conventions: - Use admonitions: !!! tip, !!! warning, !!! info - Code blocks with syntax highlighting - Tables for comparisons - Emoji icons for visual interest (sparingly) - Keyboard shortcuts in backticks

πŸš€ Launch Checklist

Before announcing v1.0 publicly:

  • All Phase 1 guides reviewed and updated
  • Screenshots added to all Phase 1 guides
  • All internal links tested
  • Guides tested by someone unfamiliar with Notifer
  • Mobile responsiveness verified
  • Search functionality working (if applicable)
  • Docs deployed to docs.notifer.io subdomain

πŸ“ž Maintenance

Guide Owners: - Account Setup, User Settings: @team-frontend - Topic Creation, Topic Settings: @team-frontend - Dashboard, Notifications: @team-frontend - Mobile App: @team-mobile - API, Troubleshooting: @team-backend - FAQ: @team-support

Review Schedule: - After each feature release - Monthly review for accuracy - Quarterly comprehensive update - Update based on support tickets

Last Updated: 2025-11-10 Status: Phase 1 templates complete, ready for content verification Next Milestone: Pre-launch screenshot addition and flow testing