Prompting Workflow: Task Document - da-moon/llm-playground GitHub Wiki

Table Of Contents

1. Overview

Purpose:

The Task Document provides detailed instructions and guidelines for completing a specific, self-contained piece of work. It ensures that the task is clearly defined, the steps are outlined, and the expected outcomes are documented.

When to Use:

  • When starting a new chat thread to implement a particular feature or component.
  • When breaking down a larger project into smaller, manageable tasks.

2. Structure and Content

2.1 Task Overview

Purpose: Provide a brief summary of the task, its purpose, and its place within the larger project.

Content:

  • Task Name: The title of the task.
  • Description: A brief description of what the task entails.
  • Purpose: Why this task is important and how it fits into the overall project.
  • Dependencies: Any other tasks or components that this task depends on.

2.2 Detailed Instructions

Purpose: Offer step-by-step instructions on how to complete the task, ensuring all necessary steps are covered.

Content:

  • Step 1:

    • Description: Detailed explanation of the first step.
    • Example: Provide any examples, if applicable.
    • Tools/Resources: Mention any tools, libraries, or resources needed for this step.
  • Step 2:

    • Description: Detailed explanation of the next step.
    • Example: Provide any examples, if applicable.
    • Tools/Resources: Mention any tools, libraries, or resources needed for this step.

(Continue for all steps necessary to complete the task)

2.3 Checklist

Purpose: Create a checklist of items to ensure that all parts of the task are completed.

Content:

  • Item 1: A specific item or subtask that needs to be completed.
  • Item 2: Another item or subtask that needs to be completed.

(Continue for all items)

2.4 Expected Outcome

Purpose: Clearly define what the completed task should look like, including any specific deliverables.

Content:

  • Deliverable 1: Description of the first deliverable.
  • Deliverable 2: Description of the second deliverable.
  • Quality Criteria: Any quality standards or criteria that the deliverables should meet.

2.5 Feedback Loop

Purpose: Provide a mechanism for gathering feedback and making adjustments to the task based on the outcome.

Content:

  • Feedback Process: How and when feedback should be gathered.
  • Adjustments: Any potential adjustments or iterations that might be needed based on feedback.