Files
tendril/docs/PROMPTS/00-Project-Status-Check-Prompt.md
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

5.1 KiB

Project Status Check Prompt

Purpose: Check current status of all project phases in the Tendril repository and provide a comprehensive status summary.

How to Use: Drag this entire document into a Cursor chat session. The AI assistant will read all phase blueprints and provide a status overview including phase completion, deliverables, and any issues.


CRITICAL: Information Gathering

Required Information (You should provide this)

No additional information required. The AI will automatically:

  • Find all phase directories in tendril/phases/
  • Read phase blueprint files
  • Extract status information

If Information is Missing

ALWAYS ASK for missing required information before proceeding. Do not make assumptions about:

  • Phase directory structure
  • Blueprint file locations
  • Status indicator formats

Step-by-Step Process

Phase 1: Discover Phase Directories

  1. Find all phase directories:

    find tendril/phases -type d -name "phase-*" | sort
    
    • Should list all phase directories
    • Format: tendril/phases/phase-XX-name/
  2. Validation:

    • Verify phase directories are found
    • Check naming follows phase-XX-name pattern
    • Confirm directories exist

Phase 2: Read Phase Blueprints

For each phase directory found:

  1. Read the blueprint file:

    • Path: tendril/phases/phase-XX-name/blueprint.md
    • Extract: Phase name, status, key deliverables, milestones
  2. Read the tasks file:

    • Path: tendril/phases/phase-XX-name/tasks.md
    • Extract: Task completion status, open tasks
  3. Validation:

    • Verify blueprint file exists
    • Confirm status indicators are readable
    • Check deliverables are listed

Phase 3: Compile Status Summary

  1. Organize by status:

    • Complete phases
    • 🔄 In Progress phases
    • Planned phases
  2. Count phases:

    • Total phases
    • Complete count
    • In Progress count
    • Planned count
  3. Extract key information:

    • Phase names and numbers
    • Current status for each
    • Key deliverables per phase
    • Any blockers or issues mentioned
  4. Validation:

    • All phases are accounted for
    • Status counts are accurate
    • No phases are missing

Phase 4: Present Status Report

  1. Create summary table:

    • Phase | Status | Key Deliverables | Notes
  2. Provide overview:

    • Total phases: X
    • Complete: X
    • In Progress: X
    • Planned: X
  3. Highlight issues:

    • Any phases with blockers
    • Phases behind schedule
    • Missing or incomplete deliverables
  4. Validation:

    • Summary is complete
    • All phases are included
    • Status is accurate

Error Handling

Common Issues

Phase Directory Not Found

  • Error message: "No phase directories found" or "Directory does not exist"
  • Fix:
    1. Verify you're in the repository root
    2. Check tendril/phases/ directory exists
    3. Confirm phase naming follows phase-XX-name pattern
  • Prevention: Always check directory structure before reading files

Blueprint File Missing

  • Error message: "File not found: blueprint.md"
  • Fix:
    1. Check if blueprint.md exists in phase directory
    2. Verify file name is exactly blueprint.md (case-sensitive)
    3. Check file permissions
  • Prevention: Verify file exists before attempting to read

Invalid Status Format

  • Error message: "Status indicator not recognized"
  • Fix:
    1. Check status format in blueprint
    2. Look for: Complete, 🔄 In Progress, Planned
    3. Handle variations or typos gracefully
  • Prevention: Document expected status formats

No Phases Found

  • Error message: "No phase directories found"
  • Fix:
    1. Verify repository structure
    2. Check if phases directory exists
    3. Confirm you're in correct repository
  • Prevention: Validate repository structure before starting

Validation Checklist

Before completing, verify:

  • All phase directories discovered
  • All blueprint files read successfully
  • Status extracted for each phase
  • Phase counts are accurate (total = complete + in progress + planned)
  • Summary table includes all phases
  • Key deliverables listed for each phase
  • Issues or blockers identified (if any)
  • Report is clear and actionable

Important Notes for AI Assistant

  1. Read all phases: Don't skip any phase directories, even if they seem incomplete
  2. Preserve status indicators: Use exact status indicators (, 🔄, ) from blueprints
  3. Handle missing data gracefully: If a blueprint is missing information, note it but continue
  4. Provide context: Include phase numbers and names in the summary
  5. Be thorough: Check both blueprint.md and tasks.md for complete status
  6. Use Tendril terminology: Reference "Tendril" project, not "pairs" or placeholders
  7. Gitea context: Note that this is a Gitea repository (not GitHub)

Location: docs/PROMPTS/00-Project-Status-Check-Prompt.md
Related:

  • tendril/phases/ - Phase directories
  • docs/PROMPTS/LLM-Usage-Guide.md - LLM execution guidelines
  • docs/PROMPTS/Prompt-Creation-Guide.md - Prompt creation guide