Prompting Workflow: Decision Log - da-moon/llm-playground GitHub Wiki

Table Of Contents

1. Overview

Purpose:

The Decision Log serves as a centralized record of all major decisions made throughout the project, along with the reasoning behind them. This document helps maintain a historical record of why certain choices were made, which can be useful for future reference or if changes are needed.

When to Use:

  • Continuously, as decisions are made throughout the project lifecycle.
  • When a decision needs to be revisited or reviewed in the future.

2. Structure and Content

2.1 Decision Summary

Purpose: Provide a brief summary of the decision, capturing the essence of the choice made.

Content:

  • Decision ID: A unique identifier for the decision.
  • Title: A short, descriptive title for the decision.
  • Date: The date when the decision was made.
  • Decision Maker: Who made the decision (e.g., team lead, group consensus).

2.2 Context

Purpose: Describe the problem or context that led to the decision. This helps future readers understand why the decision was necessary.

Content:

  • Problem Statement: A clear description of the issue or context.
  • Background Information: Any relevant background details that informed the decision.

2.3 Alternatives Considered

Purpose: Document the other options that were considered before the final decision was made.

Content:

  • Alternative 1:
    • Description: A brief description of the alternative.
    • Pros and Cons: The advantages and disadvantages of this option.
  • Alternative 2:
    • Description: A brief description of the alternative.
    • Pros and Cons: The advantages and disadvantages of this option.

(Continue for all alternatives considered)

2.4 Final Decision

Purpose: Record the final decision and explain why it was chosen over the alternatives.

Content:

  • Description: A detailed explanation of the final decision.
  • Rationale: The reasoning behind choosing this option.
  • Expected Impact: How this decision is expected to impact the project.

2.5 Follow-Up Actions

Purpose: Identify any actions that need to be taken as a result of the decision.

Content:

  • Action 1:
    • Description: A brief description of the action to be taken.
    • Owner: Who is responsible for this action.
    • Deadline: When the action needs to be completed.

(Continue for all follow-up actions)