GeneralBots/botserver
2
1
Fork 0
Code Issues Pull requests Projects Releases 323 Packages Wiki Activity Actions
botserver/docs/src/chapter-04-gbui/how-to/README.md

253 lines
12 KiB
Markdown
Raw Normal View History

- Screen manuals.
2025-11-30 22:33:54 -03:00
# How To... Tutorials
> **📖 Step-by-Step Guides for General Bots Suite**
>
> *Clear instructions for common tasks, inspired by classic computer manuals*
---
```
┌─────────────────────────────────────────────────────────────────────────┐
│ │
│ ╔═══════════════════════════════════════════════════════════════╗ │
│ ║ ║ │
│ ║ ██╗ ██╗ ██████╗ ██╗ ██╗ ████████╗ ██████╗ ║ │
│ ║ ██║ ██║██╔═══██╗██║ ██║ ╚══██╔══╝██╔═══██╗ ║ │
│ ║ ███████║██║ ██║██║ █╗ ██║ ██║ ██║ ██║ ║ │
│ ║ ██╔══██║██║ ██║██║███╗██║ ██║ ██║ ██║ ║ │
│ ║ ██║ ██║╚██████╔╝╚███╔███╔╝ ██║ ╚██████╔╝ ██╗ ║ │
│ ║ ╚═╝ ╚═╝ ╚═════╝ ╚══╝╚══╝ ╚═╝ ╚═════╝ ╚═╝ ║ │
│ ║ ║ │
│ ╚═══════════════════════════════════════════════════════════════╝ │
│ │
│ Your Guide to General Bots Suite │
│ │
└─────────────────────────────────────────────────────────────────────────┘
```
---
## About These Tutorials
These tutorials are designed like the classic computer manuals of the early 1990s — clear, numbered steps with visual diagrams showing exactly what to do. Each tutorial follows the same format:
- **Objective** — What you'll accomplish
- **Time Required** — How long it takes
- **Prerequisites** — What you need before starting
- **Steps** — Numbered instructions with screenshots
- **Troubleshooting** — Common problems and solutions
- **Next Steps** — What to learn next
---
## 🚀 Getting Started
| Tutorial | Description | Time |
|----------|-------------|------|
| [Create Your First Bot](./create-first-bot.md) | Set up a working bot from scratch | 10 min |
| [Your First Conversation](./first-conversation.md) | Talk to your bot and understand responses | 5 min |
| [Understanding the Interface](./understanding-interface.md) | Navigate the Suite like a pro | 10 min |
---
## 💬 Chat & Conversations
| Tutorial | Description | Time |
|----------|-------------|------|
| [Ask Questions Effectively](./ask-questions.md) | Get better answers from your AI assistant | 5 min |
| [Use Voice Input](./voice-input.md) | Talk instead of type | 3 min |
| [Create Chat Shortcuts](./chat-shortcuts.md) | Set up quick commands | 10 min |
| [Export Conversations](./export-conversations.md) | Save chat history for reference | 5 min |
---
## 📁 File Management (Drive)
| Tutorial | Description | Time |
|----------|-------------|------|
| [Upload Your First File](./upload-files.md) | Add documents to Drive | 3 min |
| [Organize with Folders](./organize-folders.md) | Create a logical file structure | 10 min |
| [Share Files Securely](./share-files.md) | Grant access to team members | 5 min |
| [Search for Documents](./search-documents.md) | Find files instantly | 5 min |
---
## 📚 Knowledge Base
| Tutorial | Description | Time |
|----------|-------------|------|
| [Add Documents to Knowledge Base](./add-kb-documents.md) | Teach your bot from files | 15 min |
| [Import a Website](./import-website.md) | Crawl and learn from web pages | 10 min |
| [Create FAQ Responses](./create-faq.md) | Define question-answer pairs | 15 min |
| [Manage Collections](./manage-collections.md) | Organize knowledge by topic | 10 min |
---
## 🔧 BASIC Dialogs
| Tutorial | Description | Time |
|----------|-------------|------|
| [Write Your First Dialog](./write-first-dialog.md) | Create a simple conversation script | 20 min |
| [Use HEAR and TALK](./hear-and-talk.md) | Gather and display information | 10 min |
| [Store User Information](./store-user-info.md) | Remember data between conversations | 15 min |
| [Call External APIs](./call-external-apis.md) | Connect to web services | 20 min |
| [Send Automated Messages](./send-automated.md) | Schedule broadcasts and reminders | 15 min |
---
## 📱 Messaging Channels
| Tutorial | Description | Time |
|----------|-------------|------|
| [Connect WhatsApp](./connect-whatsapp.md) | Set up WhatsApp Business integration | 30 min |
| [Configure Email](./configure-email.md) | Enable email conversations | 15 min |
| [Set Up SMS](./setup-sms.md) | Add text message support | 15 min |
| [Embed Web Chat](./embed-web-chat.md) | Add chat to your website | 10 min |
---
## 📊 Analytics & Monitoring
| Tutorial | Description | Time |
|----------|-------------|------|
| [View Bot Statistics](./view-statistics.md) | Understand usage metrics | 10 min |
| [Monitor Live Sessions](./monitor-sessions.md) | Watch conversations in real-time | 10 min |
| [Create Custom Reports](./create-reports.md) | Build dashboards for insights | 20 min |
| [Export Analytics Data](./export-analytics.md) | Download metrics for external analysis | 10 min |
---
## 🎨 Customization
| Tutorial | Description | Time |
|----------|-------------|------|
| [Change Your Bot's Theme](./change-theme.md) | Customize colors and appearance | 10 min |
| [Add a Custom Logo](./add-logo.md) | Brand your bot interface | 5 min |
| [Create Custom Cards](./create-cards.md) | Design rich message layouts | 20 min |
| [Modify the Welcome Message](./welcome-message.md) | Personalize the first interaction | 5 min |
---
## 🏢 Templates
| Tutorial | Description | Time |
|----------|-------------|------|
| [Install the CRM Template](./install-crm.md) | Set up customer relationship management | 20 min |
| [Use the HR Template](./use-hr-template.md) | Deploy employee self-service | 15 min |
| [Configure Compliance Bot](./configure-compliance.md) | Enable privacy request handling | 25 min |
| [Build from Template](./build-from-template.md) | Customize a template for your needs | 30 min |
---
## 🔒 Security & Administration
| Tutorial | Description | Time |
|----------|-------------|------|
| [Set Up User Authentication](./setup-auth.md) | Enable secure login | 20 min |
| [Configure Permissions](./configure-permissions.md) | Control who can do what | 15 min |
| [Enable Audit Logging](./enable-audit.md) | Track all system activities | 10 min |
| [Backup Your Bot](./backup-bot.md) | Protect your configuration and data | 15 min |
---
## 🐛 Troubleshooting
| Tutorial | Description | Time |
|----------|-------------|------|
| [Debug Dialog Errors](./debug-dialogs.md) | Fix common BASIC script problems | 15 min |
| [Resolve Connection Issues](./resolve-connections.md) | Troubleshoot network problems | 10 min |
| [Fix Knowledge Base Gaps](./fix-kb-gaps.md) | Improve bot answers | 20 min |
| [Performance Optimization](./performance-tips.md) | Make your bot faster | 15 min |
---
## Quick Reference Card
```
┌─────────────────────────────────────────────────────────────────────────┐
│ QUICK REFERENCE CARD │
├─────────────────────────────────────────────────────────────────────────┤
│ │
│ KEYBOARD SHORTCUTS │
│ ───────────────── │
│ Ctrl + Enter ........ Send message │
│ Ctrl + K ............ Quick command palette │
│ Ctrl + / ............ Toggle voice input │
│ Ctrl + N ............ New item (context-aware) │
│ Ctrl + S ............ Save current work │
│ Escape .............. Close dialog/panel │
│ │
│ COMMON BASIC KEYWORDS │
│ ──────────────────── │
│ TALK "message" ...... Display message to user │
│ HEAR variable ....... Wait for user input │
│ SET BOT MEMORY ...... Store bot-wide data │
│ GET USER MEMORY ..... Retrieve user-specific data │
│ USE KB "name" ....... Activate knowledge base │
│ SEND MAIL ........... Send email notification │
│ │
│ WHERE TO GET HELP │
│ ───────────────── │
│ • Type "help" in Chat for assistance │
│ • Press F1 anywhere for context help │
│ • Visit community.pragmatismo.com for forums │
│ • Email support@pragmatismo.com for enterprise support │
│ │
└─────────────────────────────────────────────────────────────────────────┘
```
---
## Tips for Following Tutorials
### ✅ Before You Start
1. **Bookmark this page** — You'll return to it often
2. **Have the Suite open** — Follow along step-by-step
3. **Take notes** — Write down customizations you make
4. **Don't skip steps** — Each step builds on the previous
### ✅ While Following Steps
1. **Read the entire step first** — Then perform the action
2. **Match the screenshots** — If your screen looks different, stop and check
3. **Use exact values** — Type what the tutorial shows, then customize later
4. **Check results** — Verify each step worked before moving on
### ✅ If Something Goes Wrong
1. **Don't panic** — Most problems have simple solutions
2. **Re-read the step** — You may have missed something
3. **Check Troubleshooting** — Each tutorial has a help section
4. **Ask for help** — The Chat assistant can guide you
---
## Icon Legend
Throughout these tutorials, you'll see these indicators:
| Icon | Meaning |
|------|---------|
| 💡 | **Tip** — Helpful suggestion to work more efficiently |
| ⚠️ | **Warning** — Important caution to avoid problems |
| 📝 | **Note** — Additional information or context |
| ✅ | **Checkpoint** — Verify your progress before continuing |
| 🔧 | **Configuration** — Settings you may need to adjust |
---
## Version Information
These tutorials are written for:
- **General Bots Suite** version 5.0+
- **Browser**: Chrome, Firefox, Safari, or Edge (latest versions)
- **Last Updated**: 2025
If you're using an older version, some screens may look different.
---
*"The best way to learn is to do."*
**Start with [Create Your First Bot](./create-first-bot.md)** →
Reference in a new issue Copy permalink