107 lines
2.7 KiB
Markdown
107 lines
2.7 KiB
Markdown
# Prompts Directory
|
||
|
||
This directory contains workflow prompts and process templates for AI-guided operations.
|
||
|
||
## Contents
|
||
|
||
- `session-wrap-up.prompt.md` — End-of-session documentation and cleanup workflow
|
||
|
||
## Purpose
|
||
|
||
Prompt files define structured, repeatable workflows for complex multi-step operations. Each prompt file specifies:
|
||
|
||
- Clear goal and success criteria
|
||
- Pre-execution checklist
|
||
- Step-by-step execution instructions
|
||
- Validation and verification steps
|
||
- Rollback and recovery procedures
|
||
|
||
## Prompt File Structure
|
||
|
||
All workflow prompts must follow this template:
|
||
|
||
```markdown
|
||
---
|
||
title: "[Workflow Name] Prompt"
|
||
description: "Brief description"
|
||
status: "✅ Approved"
|
||
---
|
||
|
||
# [Workflow Name] Prompt
|
||
|
||
## Goal
|
||
[Clear, measurable objective]
|
||
|
||
## Pre-[Action] Checklist
|
||
- [ ] Item 1
|
||
- [ ] Item 2
|
||
|
||
## [Action] Execution (In Order)
|
||
### Step 1: [Action]
|
||
[Detailed instructions]
|
||
|
||
### Step 2: [Action]
|
||
[Detailed instructions]
|
||
|
||
## Success Criteria
|
||
- [ ] Criterion 1
|
||
- [ ] Criterion 2
|
||
|
||
## [Workflow] Time Estimate
|
||
- X–Y minutes for typical case
|
||
```
|
||
|
||
## Usage
|
||
|
||
Prompts are invoked through:
|
||
- Direct user request: "Follow instructions in [prompt-name].prompt.md"
|
||
- Agent workflows that reference the prompt
|
||
- Automated triggers (e.g., session end, deployment)
|
||
|
||
## Standards
|
||
|
||
All prompt files must:
|
||
- Use `.prompt.md` extension
|
||
- Include YAML frontmatter with `title`, `description`, `status`
|
||
- Have required sections: Goal, Pre-Checklist, Execution, Success Criteria
|
||
- Use numbered, sequential steps for execution
|
||
- Include time estimates
|
||
- Provide restart/rollback instructions where applicable
|
||
- Be tested before committing
|
||
|
||
## Quality Requirements
|
||
|
||
Before adding a new prompt:
|
||
|
||
1. ✅ Test in isolation with sample data
|
||
2. ✅ Verify all sections execute correctly
|
||
3. ✅ Confirm success criteria are measurable
|
||
4. ✅ Document expected resource usage
|
||
5. ✅ Get user approval for production use
|
||
|
||
## Creating New Prompts
|
||
|
||
Template for new workflow prompts:
|
||
|
||
```bash
|
||
cp .github/prompts/session-wrap-up.prompt.md .github/prompts/[new-workflow].prompt.md
|
||
# Edit file following the structure
|
||
# Test execution
|
||
# Update this README
|
||
```
|
||
|
||
## Related Documentation
|
||
|
||
- [GitHub Folder Rules](../instructions/GITHUB_FOLDER_RULES.md) — Strict gating requirements
|
||
- [Core Instructions](../instructions/core.instructions.md) — Foundational principles
|
||
- [Agents](../agents/) — Workflow orchestration systems
|
||
- [Session Wrap-Up Example](./session-wrap-up.prompt.md) — Reference implementation
|
||
|
||
## Maintenance
|
||
|
||
Prompts should be:
|
||
- ✅ Reviewed after each use for improvements
|
||
- ✅ Updated when dependent systems change
|
||
- ✅ Tested quarterly to ensure continued validity
|
||
- ✅ Versioned (not overwritten) when making breaking changes
|