UNPKG

create-ai-chat-context

Version:

🚀 BREAKTHROUGH: Detection-Hourglass-System (DHS) - Revolutionary auto-detection of AI conversation chunks with zero-cost processing. Universal AI memory that actually works!

114 lines (81 loc) • 2.84 kB
# Project Overview > **📋 QUICK CONTEXT FOR AI:** > > This file provides essential project context. Read the "Quick Reference" section first for immediate context, then dive into details as needed. --- ## 🎯 Quick Reference (AI: Read This First!) **Project:** [Your Project Name] **Type:** [CLI Tool / Web App / API / Library / Mobile App] **Language:** [Primary Language] **Status:** [In Development / Production / Maintenance] **What it does (one sentence):** [Describe your project in one clear, concise sentence] **Current focus:** [What you're working on right now - e.g., "v1.0.0 release", "Adding authentication", "Performance optimization"] **Key files to know:** - `[path/to/main/file]` - [What it does] - `[path/to/important/file]` - [What it does] - `[path/to/config/file]` - [What it does] **Conventions:** - **Modules:** [CommonJS / ES Modules / etc.] - **File naming:** [kebab-case / camelCase / PascalCase] - **Variable naming:** [camelCase / snake_case] - **Testing:** [Manual / Jest / Pytest / etc.] **Workflow:** - [Key workflow step 1] - [Key workflow step 2] - [Key workflow step 3] --- ## 📖 Detailed Overview (For Humans & Deep Dives) ### Problem Statement **The Challenge:** [What problem does this project solve? Who experiences it? Why is it a problem?] **The Solution:** [How does your project solve it? What makes it unique? Who benefits?] ### What This Project Does **Key Features:** - Feature 1: [Description] - Feature 2: [Description] - Feature 3: [Description] **Important Limitations:** - [What is out of scope] - [What this project doesn't handle] - [What users should not expect] ### Architecture **High-Level Structure:** ``` [Describe or diagram your system architecture] ``` **Technology Stack:** - **Language:** [Primary language and version] - **Framework:** [Framework if applicable] - **Database:** [Database if applicable] - **Tools:** [Build tools, testing frameworks, etc.] ### Key Components **List your main components/modules here:** - Component 1: [Brief description] - Component 2: [Brief description] - Component 3: [Brief description] ### Current Goals **Short-term (This Week/Month):** - [ ] Goal 1 - [ ] Goal 2 - [ ] Goal 3 **Long-term (This Quarter/Year):** - [ ] Goal 1 - [ ] Goal 2 - [ ] Goal 3 --- ## 📚 Additional Resources **Related Documentation:** - See `conversation-log.md` for project history - See `technical-decisions.md` for architecture decisions - See `next-steps.md` for current priorities - See `code-style.md` for coding standards - See `design-system.md` for design patterns **External Links:** - Repository: [URL] - Documentation: [URL] - Issue Tracker: [URL] --- **💡 Tip:** Keep the "Quick Reference" section at the top updated - it's the first thing AI assistants will read when they need project context!