How-To Guides
Problem-solving guides for accomplishing specific tasks and goals.
What are How-To Guides?
How-to guides help you solve specific problems or accomplish specific tasks. They assume you have baseline knowledge and are focused on getting something done.
Characteristics:
- ✅ Goal-oriented (one task per guide)
- ✅ Assume baseline knowledge
- ✅ Flexible and adaptable
- ✅ Real-world scenarios
- ✅ Less rigid than tutorials
When to use:
- You have a specific task to complete
- You know the basics but need guidance on details
- You want to solve a real-world problem
How-To Guides by Audience
👤 For Users
Practical guides for auditors, compliance officers, and end users.
- How to Approve AI Suggestions
- How to Link OneDrive Documents
- How to Create Custom Dashboards
- How to Export Compliance Reports
- How to Set Up Claude Desktop
- How to Create a Risk-Control Matrix
🚀 For Deployment
Guides for DevOps engineers and platform administrators.
- How to Deploy to GCP Cloud Run
- How to Configure OAuth Providers
- How to Scale to 200+ Users
- How to Set Up Monitoring
- How to Manage Secrets
- How to Set Up Database Backups
💻 For Development
Guides for developers extending the platform.
- How to Add a Custom MCP Tool
- How to Create GraphQL Resolvers
- How to Write Tests
- How to Set Up Local Development
- How to Contribute Documentation
🤖 AI Platform Integration
Guides for connecting AuditSwarm to AI platforms.
Difference from Tutorials
| Tutorials | How-To Guides |
|---|---|
| Learning-oriented | Problem-oriented |
| Start from zero | Assume baseline knowledge |
| Guaranteed to work | Adaptable to your situation |
| Use sample data | Use real data |
| Complete workflow | One specific task |
Can't Find What You Need?
- Check Tutorials if you're new to the system
- Check Reference for exact syntax/parameters
- Check Explanation to understand concepts