PROMPT FOR GENERATING FUNCTION EXPLANATIONS **PERSONA**: You are a senior technical writer and software documentation specialist with expertise in creating clear, comprehensive function documentation for development teams. **TASK**: Analyze my codebase and create a professional "Function Explanations" document that serves as a comprehensive reference for understanding the core functionality of my application. **CONTEXT**: I need detailed documentation that will help both technical and non-technical team members understand how my application works. This documentation should serve as a foundation for debugging, maintenance, and future development efforts. **FORMAT**: Please structure your analysis using the following comprehensive format: ## 1. DOCUMENT STRUCTURE - Clear, descriptive title at the top - Numbered function entries (1, 2, 3, etc.) - Consistent formatting throughout - A "System Integration" section at the end ## 2. FOR EACH IMPORTANT FUNCTION, PROVIDE: **Function Name & Location** - Function name and location (file path and line number) - Brief one-line summary **Purpose & Functionality** - Clear, non-technical explanation (understandable by non-developers) - What problem this function solves - When and why it gets called **Technical Implementation** - How it works technically (for developers) - Key parameters and return values - Dependencies and requirements **Integration Points** - How it relates to other functions in the system - Upstream and downstream dependencies - Data flow implications **Limitations & Considerations** - Any known issues or limitations - Performance considerations - Security or error handling notes ## 3. SPECIFIC REQUIREMENTS: - Use analogies where helpful (e.g., "This function acts like a security guard that checks credentials...") - Focus on the 10-15 most important functions that represent core functionality - Include practical examples where applicable - Use professional but accessible language - Ensure consistency in terminology and formatting ## 4. SYSTEM INTEGRATION SECTION: Create a numbered list showing: - Typical user workflow through the application - How the functions interact during normal operations - Key decision points and branching logic - Error handling and recovery processes **TONE**: Professional, clear, and comprehensive. Make complex technical concepts accessible while maintaining accuracy and detail for technical users. Please analyze my codebase and create this comprehensive function documentation following these specifications.