Sherafy Codebook

CODING PROJECT CONTEXT TEMPLATE

This template ensures the LLM has comprehensive context and prompts it to ask follow-up questions rather than making assumptions.

Begin prompt

[!TIP]

  • Fill in all relevant sections before your specific coding request
  • If some sections are too specific or out of scope, you can omit
  • Be as specific as possible with paths, versions, and configurations
  • Include any unique aspects of your setup that differ from standard installations
  • The final request explicitly asks the LLM to probe for missing context
  • Adapt sections based on your project type (web app, API, desktop app, etc.)
  • Edit each field inline (yes you can type directly if viewing on ‘codebook.sherafy.com’ and not github)
  • Copy and paste to your LLM. Your answers will be in line, with labels and answers together
  • For multiline answers, just type and use Shift+Enter for line breaks if needed
  • Don’t refresh this page if typing in values or you will be sad.

Copy below this line, edit, and pass to LLM.

You can edit the fields with custom values. Triple click each cell to replace the text with your own.

System Environment & Infrastructure

Operating System: e.g., Debian 12, Ubuntu 22.04, Windows 11
Web Server: e.g., Apache 2.4, Nginx 1.18, IIS
Control Panel: e.g., ISPConfig, cPanel, Plesk, or none
Domain/URL: your-domain.com
Document/Web Root: e.g., /var/www/clients/client0/web1/web/
Project Root: e.g., /var/www/clients/client0/web1/project/
Database: MySQL 8.0, PostgreSQL 14, SQLite, etc.
Runtime Environment: Node.js v18, Python 3.11, PHP 8.2, etc.

Current Project Architecture

Framework/CMS: e.g., Strapi, WordPress, Laravel, Express.js
Frontend Technology: React, Vue, vanilla JS, static HTML
Backend Location: Full path if separate from web root
API Endpoints: Existing API structure/routes
Build Tools: webpack, Vite, npm scripts, etc.
Process Management: PM2, systemd, supervisor, etc.

Network & Security Configuration

SSL/HTTPS Status: configured/not configured
Proxy Configuration: Existing Apache/Nginx proxy rules
Firewall/Ports: Relevant open ports and restrictions
Authentication: JWT, sessions, OAuth, etc.

Current State & Working Components

What's Currently Working: List functional features
What's in Web Directory: Current contents of document root
Existing Configuration Files: Relevant config files and their locations
Dependencies Installed: Key packages, versions
Permission Structure: User/group ownership, any permission constraints

Project Goals & Requirements

Primary Objective: What you're trying to accomplish
Specific Features Needed: Detailed feature requirements
URL Structure Plan: How you want routes organized
Performance Requirements: Any speed/optimization needs
Integration Points: APIs, third-party services, etc.

Known Constraints & Preferences

ISP/Hosting Limitations: Shared hosting restrictions, etc.
Technology Preferences: Preferred libraries, patterns, etc.
Compatibility Requirements: Browser support, mobile, etc.
Deployment Constraints: CI/CD, manual deployment, etc.

Development Context

Development Stage: Initial setup, mid-development, production ready
Team Size: Solo, small team, etc.
Maintenance Requirements: Long-term maintainability needs
Documentation Needs: Level of commenting/docs required

REQUEST:

Based on this context, I need help with: Describe your specific coding task or question here


To ensure the code works flawlessly on first implementation, please ask me any clarifying questions about missing details, assumptions, or specifics about my setup that could affect the solution. I want to avoid generic examples and ensure the code accounts for my exact environment and constraints.