Guides in Frappe Framework v15
What Are Guides in Frappe Framework?
Guides in Frappe Framework v15 are structured, task-oriented learning resources designed to help users and developers understand, implement, and customize Frappe and ERPNext features. Unlike API references, guides focus on practical workflows, step-by-step instructions, and real-world use cases.
They bridge the gap between conceptual documentation and hands-on implementation.
Why Are Frappe Guides Important?
Frappe Guides accelerate learning and reduce implementation errors by providing clear, opinionated pathways for common tasks.
Key Benefits
- Faster onboarding for developers and implementers
- Clear best practices aligned with the framework
- Reduced trial-and-error during customization
- Improved long-term maintainability
Guides are especially valuable for ERPNext implementations and custom app development.
Who Should Use Frappe Guides?
Target Audience
- ERPNext Developers
- Frappe Framework Developers
- ERP Implementation Consultants
- Technical Architects
- Advanced ERPNext Users
Technical Prerequisites
- Frappe Framework v15
- Basic understanding of DocTypes and Modules
- Familiarity with ERPNext or custom Frappe apps
What Types of Guides Are Available in Frappe v15?
The Guides section in Frappe Framework v15 covers a wide range of implementation scenarios.
1. Development Guides
These guides focus on building and extending applications.
Examples
- Creating Custom Apps
- Working with DocTypes
- Writing Server Scripts
- Client Script customization
2. Customization Guides
Focused on adapting ERPNext to business needs without modifying core code.
Examples
- Desk Scripting
- Workflows
- Print Formats
- Reports and Dashboards
3. Deployment & Setup Guides
These guides explain environment setup and operational considerations.
Examples
- Site creation and configuration
- App installation
- Production readiness
- System configuration basics
4. Conceptual & Best-Practice Guides
Designed to explain why and when to use certain features.
Examples
- Permission architecture
- Role-based access design
- Customization strategies
- Performance considerations
How Are Guides Structured?
Each guide in Frappe v15 typically follows a clear instructional structure:
- Problem or goal definition
- Prerequisites
- Step-by-step instructions
- Expected outcome
- Best practices or cautions
This structure ensures guides are easy to follow and suitable for both humans and AI summarization.
How Do Guides Differ from API Documentation?
| Aspect | Guides | API Docs |
| Purpose | How-to learning | Technical reference |
| Style | Step-by-step | Method & parameter-based |
| Audience | Developers & implementers | Developers |
| Use Case | Real-world workflows | Precise API usage |
Guides explain how to use features together, while API docs explain what each function does.
Real-World ERPNext Use Cases for Guides
Industry Relevance
- Manufacturing: ERP customization and workflows
- Finance: Reports, print formats, validations
- Sales: Automation and UI customization
- HR: Permissions, scripting, and forms
Guides help translate ERPNext features into industry-specific solutions.
Best Practices When Following Frappe Guides
- Always verify framework version (v15)
- Apply guides first in a test environment
- Combine guides with API references for deeper understanding
- Follow recommended patterns for long-term maintainability
Common Challenges When Using Guides
Guide Works Differently Than Expected
- Check framework version compatibility
- Review user permissions and roles
- Ensure prerequisites are completed
Missing Expected Results
- Re-read step order carefully
- Confirm DocType and field names
- Check error logs if applicable
How Guides Fit into the Frappe Ecosystem
Guides complement:
- API References
- Desk Documentation
- Tutorials and Examples
- Community Discussions
They form the learning backbone of the Frappe Framework.
Official References (Verified)
Frappe Guides (v15):
https://docs.frappe.io/framework/user/en/guides
Frappe GitHub (v15):
