Explanation Documentation
Understanding-oriented content that explains the "why" behind the system.
What is Explanation Documentation?
Explanations help you understand concepts, design decisions, and context. They discuss alternatives, trade-offs, and the reasoning behind how AuditSwarm works.
Characteristics:
- ✅ Discusses "why" not "how"
- ✅ Explores alternatives and trade-offs
- ✅ Provides background and context
- ✅ Opinion and rationale allowed
- ✅ No step-by-step instructions
When to use:
- You want to understand why something works the way it does
- You're curious about design decisions
- You need to explain the system to stakeholders
- You want deeper knowledge beyond surface-level usage
Explanation Sections
🏗️ Architecture
Deep dives into architectural patterns and design.
- Why the Suggestions Pattern is Safe for AI
- Understanding Dual-Transport MCP
- GraphQL-First Architecture
- How Context Tracking Works
🔒 Compliance
How AuditSwarm achieves compliance certifications.
- How AuditSwarm Achieves SOC2 Compliance
- ISO 27001 Controls Implementation
- Audit Trail Design
- RBAC Security Model
💭 Design Decisions
Rationale behind major technical decisions.
Difference from Other Doc Types
| Tutorials | How-To | Reference | Explanation |
|---|---|---|---|
| Learning | Problem-solving | Lookup | Understanding |
| Step-by-step | Task-focused | Factual | Conceptual |
| Narrative | Flexible | Exhaustive | Contextual |
Can't Find What You Need?
- Check Tutorials if you're learning
- Check How-To Guides for task guidance
- Check Reference for syntax/parameters