Prompting Workflow: Review and Feedback Document - da-moon/llm-playground GitHub Wiki

Table Of Contents

1. Overview

Purpose:

The Review and Feedback Document is used to collect, organize, and act on feedback regarding completed tasks, features, or designs. It ensures that feedback is systematically captured and that any necessary adjustments are made to align with project goals.

When to Use:

  • After a task, feature, or design is completed and ready for review.
  • When gathering feedback from team members, stakeholders, or users.

2. Structure and Content

2.1 Feedback Summary

Purpose: Provide an overview of the feedback received, highlighting the main points and areas of concern.

Content:

  • Summary of Feedback: A concise summary of the overall feedback.
  • Key Strengths: What worked well or was positively received.
  • Areas for Improvement: What needs to be improved or revisited.

2.2 Specific Comments

Purpose: Capture detailed feedback on specific aspects of the task or design.

Content:

  • Comment 1:

    • Description: The specific feedback provided.
    • Location/Component: Where this feedback applies (e.g., a specific file, module, or feature).
    • Suggestion: Any suggestions for improvement or change.
  • Comment 2:

    • Description: The specific feedback provided.
    • Location/Component: Where this feedback applies.
    • Suggestion: Any suggestions for improvement or change.

(Continue for all specific comments)

2.3 Action Items

Purpose: Identify and assign actionable tasks based on the feedback received.

Content:

  • Action Item 1:

    • Description: A clear description of the task to be completed based on the feedback.
    • Owner: The person responsible for completing this task.
    • Deadline: When the task should be completed.
  • Action Item 2:

    • Description: A clear description of the task to be completed based on the feedback.
    • Owner: The person responsible for completing this task.
    • Deadline: When the task should be completed.

(Continue for all action items)

2.4 Adjustments and Iterations

Purpose: Document any changes or iterations made to the task or design based on the feedback.

Content:

  • Iteration 1:

    • Description: What was changed or improved.
    • Reason: Why this change was necessary.
    • Outcome: The result or impact of the iteration.
  • Iteration 2:

    • Description: What was changed or improved.
    • Reason: Why this change was necessary.
    • Outcome: The result or impact of the iteration.