From 782ef1258bac2e405ad5aab833391177557fb35f Mon Sep 17 00:00:00 2001 From: medusa Date: Mon, 30 Jun 2025 08:49:47 +0000 Subject: [PATCH] Update tech_docs/llm/Generalized-Instruction-Optimization-Framework.md --- ...ized-Instruction-Optimization-Framework.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/tech_docs/llm/Generalized-Instruction-Optimization-Framework.md b/tech_docs/llm/Generalized-Instruction-Optimization-Framework.md index b4d7c09..5bc934b 100644 --- a/tech_docs/llm/Generalized-Instruction-Optimization-Framework.md +++ b/tech_docs/llm/Generalized-Instruction-Optimization-Framework.md @@ -1,3 +1,49 @@ +## PURPOSE +- Define **Core Objective**: State the primary goal or purpose of these instructions. +- Explain **Impact**: Briefly describe the significance or benefit of achieving this objective. + +--- + +## INPUTS +- **Description**: Briefly outline the types of information or resources these instructions require (e.g., user queries, system data). +- **Required Details**: Specify any particular data, files, or specific starting conditions needed. + +--- + +## PREREQUISITES +- **Pre-conditions**: List any essential prior knowledge, necessary tools, or required permissions before starting. + +--- + +## PROCEDURE +- **Step-by-Step Actions**: Enumerate all actions in a logical, clear, and direct order. Keep each step concise. +- **Clarity Aids (Optional)**: Suggest incorporating visuals (e.g., screenshots, diagrams) or concrete examples for complex steps. + +--- + +## OUTCOME +- **Desired Result**: Clearly state the intended result of successfully following these instructions. +- **Success Criteria**: Where applicable, define how success will be measured (e.g., specific output, completion status, user satisfaction). + +--- + +## VARIATIONS & EXCEPTIONS +- **Handling Guidelines**: Provide instructions for managing different scenarios, common exceptions, or minor deviations. +- **Escalation Path**: Specify who to contact or what team to involve for issues that cannot be resolved using these guidelines. + +--- + +## EFFICIENCY TIPS +- **Optimization Advice**: Offer quick tips for more efficient execution or highlight common pitfalls to avoid. + +--- + +## FEEDBACK & IMPROVEMENT +- **Refinement Process**: Suggest methods for gathering feedback and ensuring continuous improvement of the instructions. +- **Version Control**: Recommend a system for tracking changes and updates to the document. + +--- + ## MISSION or GOAL - **Define Clear Objective**: Start with a concise statement of the primary goal or purpose of the instructions.