1 Commits

Author	SHA1	Message	Date
Gitea Actions	6a4683022f	docs(prompts): implement Phase 4 LLM Usage Guides Setup ... This commit implements the complete LLM Usage Guides system for the Tendril project, establishing reusable prompt documents for AI-assisted workflows. ## What Was Implemented ### 1. Core Guide Documents **docs/PROMPTS/LLM-Usage-Guide.md** - Comprehensive LLM execution instructions: - Recognizing prompt documents (naming convention, structure, location) - Step-by-step execution process (5 phases: recognize, gather info, execute, handle errors, validate) - Information gathering requirements and best practices - Error handling procedures and common error patterns - Validation steps (pre-execution, during execution, post-execution) - Providing feedback (progress updates, error reporting, completion summaries) - Best practices for execution, communication, and quality - Special instructions for Tendril-specific context - Troubleshooting guide for common prompt execution issues - Customized for Tendril project structure and Gitea platform **docs/PROMPTS/Prompt-Creation-Guide.md** - Guide for creating effective prompts: - Naming convention (NN-Descriptive-Name-Prompt.md format) - Complete prompt structure template with all required sections - Best practices for writing effective instructions - Information gathering guidelines - Error handling documentation standards - Testing procedures for new prompts - Common patterns (status check, search, sync patterns) - Decision criteria for when to create new prompts - Update procedures for existing prompts - Comprehensive checklist for new prompts - Examples customized for Tendril project - References to Gitea-specific workflows and features ### 2. Initial Prompt Documents **docs/PROMPTS/00-Project-Status-Check-Prompt.md** - Project status overview: - Purpose: Check current status of all project phases - Reads all phase blueprints in tendril/phases/ - Extracts phase status, deliverables, milestones - Organizes by status (Complete, In Progress, Planned) - Provides comprehensive status summary with counts - Highlights issues or blockers - Error handling for missing files, invalid formats - Validation checklist for completion - Customized for Tendril phase structure **docs/PROMPTS/01-KB-Content-Search-Prompt.md** - KB system search: - Purpose: Search KB system for relevant content - Supports multiple search types: topics, tags, phase relevance, keywords - Uses kb/_index.md for efficient searching - Reads matching KB files and extracts metadata - Presents organized search results with summaries - Handles missing index, invalid criteria, empty results - Provides helpful suggestions for refining searches - Customized for Tendril KB structure and categories **docs/PROMPTS/02-Phase-Documentation-Sync-Prompt.md** - Phase documentation synchronization: - Purpose: Ensure phase documentation consistency - Reads all four phase documents (blueprint, tasks, decisions, changelog) - Compares and identifies discrepancies - Syncs tasks.md with blueprint deliverables and Definition of Done - Updates changelog.md with sync entry - Reviews decisions.md for missing ADRs - Verifies consistency across all documents - Follows Cursor rules for phase documentation synchronization - Error handling for missing files, format issues, unresolvable discrepancies - Customized for Tendril phase structure and documentation system ## Why This Implementation ### Standardized AI Workflows LLM Usage Guides enable consistent, repeatable AI-assisted workflows. Instead of explaining the same tasks repeatedly, prompts provide standardized instructions that work reliably every time. ### Reusability and Efficiency Prompt documents can be dragged into Cursor chat sessions and executed immediately. This saves time and ensures tasks are performed consistently across different sessions and users. ### Quality and Reliability Well-structured prompts include validation checklists, error handling, and best practices. This reduces errors and ensures high-quality results. ### Knowledge Preservation Prompts document how to perform complex tasks, preserving institutional knowledge and making it accessible to anyone who needs to perform the task. ### Integration with Project Systems Prompts are designed to work with Tendril's phase documentation system, KB system, and Gitea workflows, providing seamless integration with existing project infrastructure. ## Technical Details ### Prompt Document Structure All prompts follow a consistent structure: 1. **Title and Purpose** - Clear description of what the prompt does 2. **How to Use** - Instructions for using the prompt 3. **CRITICAL: Information Gathering** - Required information section 4. **Step-by-Step Process** - Phased execution instructions 5. **Error Handling** - Common issues and solutions 6. **Validation Checklist** - Completion verification 7. **Important Notes** - Critical instructions for AI assistant ### Naming Convention Prompts follow strict naming: - 00-09: Core system prompts - 10-19: Phase management prompts - 20-29: KB system prompts - 30-39: Workflow and automation prompts - 40-49: Documentation prompts - 50+: Project-specific prompts ### Customization for Tendril All prompts and guides are customized for: - **Project Name**: Tendril (not "pairs" or placeholders) - **Platform**: Gitea (not GitHub) - **Repository**: https://git.parkingmeter.info/Mycelium/tendril - **Directory Structure**: tendril/phases/, kb/ with category directories - **Workflows**: Gitea Actions (with GitHub Actions compatibility notes) ### Integration Points Prompts integrate with: - **Phase Documentation**: tendril/phases/phase-XX-name/ files - **KB System**: kb/ directory with index and category structure - **Workflows**: .github/workflows/ (Gitea Actions) - **Documentation**: docs/ directory structure ## Files Added - docs/PROMPTS/LLM-Usage-Guide.md - LLM execution instructions (~400 lines) - docs/PROMPTS/Prompt-Creation-Guide.md - Prompt creation guide (~600 lines) - docs/PROMPTS/00-Project-Status-Check-Prompt.md - Status check prompt (~180 lines) - docs/PROMPTS/01-KB-Content-Search-Prompt.md - KB search prompt (~240 lines) - docs/PROMPTS/02-Phase-Documentation-Sync-Prompt.md - Documentation sync prompt (~250 lines) **Total**: 5 files, ~1,670 lines of prompt documentation ## Validation All Phase 4 requirements met: - ✅ LLM Usage Guide created and comprehensive - ✅ Prompt Creation Guide created with complete template - ✅ Three initial prompt documents created - ✅ All prompts follow naming convention - ✅ All prompts include required sections - ✅ All files reference "Tendril" (42 references found) - ✅ All files use "Gitea" terminology (10 references, no GitHub) - ✅ Examples relevant to Tendril project structure - ✅ Documentation is clear and actionable ## Next Steps Phase 4 complete. LLM Usage Guides system is ready for use. Prompts can be dragged into Cursor chat sessions to perform standardized tasks. Ready for Phase 5: Validation and Testing. ## Related - Phase 4 Plan: kb/_guides/PROJECT-SETUP-GUIDE/PHASE-4-PLAN.md - Replication Guide: kb/_guides/PROJECT-SETUP-GUIDE/COMPLETE-SYSTEM-REPLICATION-GUIDE.md - Gitea LLM Guidelines: docs/GITEA/LLM-Gitea-Guidelines.md	2025-11-11 12:25:52 -07:00