How to Use This Template

This template provides your AI coding assistant with essential information about your specific environment and requirements.

Steps:

1. Download the template: Click the download button below to get the ai-context-template.md file
2. Save to your docs folder: Move the downloaded file to your project's docs/ directory (created in Getting Started)
3. Open in a text editor: Use any text editor (VS Code, Sublime Text, Notepad++, etc.) or markdown editor (Obsidian, MarkText, etc.)
4. Fill out all sections: Replace the placeholder text in brackets with your specific information
5. Provide to your AI agent: When starting each build stage, include this completed file along with the stage instructions

The AI agent will reference this file to make implementation decisions appropriate for your hosting environment, API provider, and educational context.

---

Template Preview

Below is the content of the template. Download the markdown file to edit it with your information.

AI Agent Context Template

Purpose: This file provides essential context for the AI coding assistant building this application. Fill out all sections before beginning Stage 1.

Location: Save the completed template in your docs/ folder alongside other reference materials.

Hosting Environment

Hosting provider: [e.g., Bluehost, SiteGround, DreamHost, etc.]

Control panel: [e.g., cPanel, Plesk, custom dashboard, etc.]

PHP version available: [e.g., 7.4, 8.0, 8.1, 8.2]

Server type: [e.g., Apache, Nginx]

Known restrictions or limitations: [e.g., ModSecurity enabled, specific WAF rules, upload limits, execution time limits, disabled PHP functions, etc. If unknown, write "None known"]

How environment variables are set: [e.g., "Through cPanel interface under PHP Variables", "Via .htaccess with SetEnv", "Through hosting control panel settings", etc.]

File write permissions: [Any known restrictions on where files can be written, log locations, etc. If unknown, write "Standard shared hosting"]

AI API Provider

Provider: [e.g., Google Gemini, OpenAI, Anthropic Claude, etc.]

Model to use: [e.g., gemini-1.5-flash, gpt-4, claude-3-5-sonnet, etc.]

API documentation location: [Path to saved markdown files in docs folder, or URLs if not saved]

API key storage method confirmed: [e.g., "Environment variable via cPanel", "SetEnv in .htaccess", etc.]

Request/response format notes: [Any specific formatting requirements or quirks noted in API docs]

Development Tools

FTP/SFTP client: [e.g., FileZilla, Cyberduck, WinSCP, command-line sftp, etc.]

Text editor: [e.g., VS Code, Sublime Text, Notepad++, vim, etc.]

AI coding assistant: [Specify which command-line AI coding assistant you're using]

Browser for testing: [e.g., Chrome, Firefox, Safari, Edge]

Educational Context

Primary use case: [Brief description - e.g., "High school biology homework support", "Middle school writing assistance", "General academic help for grades 6-8", etc.]

Student characteristics: [Grade level, subject area, any relevant context that might inform implementation choices]

Initial conversation framework focus: [What type of interaction you're building for initially - e.g., "General homework help", "Project brainstorming", "Concept explanation", etc.]

Project File Structure

Project directory location: [Absolute path on local machine, e.g., /Users/username/student-ai-chat/]

Remote deployment path: [Where files will be deployed on server, e.g., /public_html/ai-chat/ or subdomain location]

Git repository initialized: [Yes/No]

Additional Notes

[Any other constraints, preferences, or context the AI agent should know. Examples:

• Specific accessibility requirements
• Browser compatibility priorities
• Performance constraints
• Security requirements beyond standard
• Organizational policies that affect implementation
• Previous attempts or known issues to avoid]

Instructions for AI Agent:

This file provides essential context about the deployment environment and project requirements. Reference this information when making implementation decisions, particularly regarding:

• PHP version compatibility
• Hosting environment constraints
• API provider-specific formatting
• File paths and deployment structure

Implement each stage with minimal code to meet the stated success indicators. Follow the YAGNI principle ("You Aren't Gonna Need It") - don't add features or complexity beyond what's required for the current stage. Each stage should produce working code, not perfect code. Additional features and refinement come in later stages and customization.

If you need additional information not provided here, ask the human before proceeding with assumptions.