design-document

name	design-document
description	Standard format for design documents produced by the Architect agent

What I do

• Provide the fixed Design Document format used by the Architect agent.
• Ensure design artifacts are structured consistently for downstream consumption by Orchestrator, Implementor, and Designer.

Persistence

• Persist every design document with save-handoff.
• save-handoff stores files under ~/logs/opencode-harness/handoffs/<session-id>/.
• Draft design document:
  • handoffType: checkpoint
  • slug: <slug>-design-draft
• Final approved design document:
  • handoffType: completion
  • slug: <slug>-design
• Use kebab-case slug derived from the design title.
• If the caller/user requests a repository output path, also write the same Markdown design document to that path.

Format

Design Document

• Title: concise name for the design
• Status: draft | review | approved
• Author: architect
• Date: YYYY-MM-DD

1. Problem Statement

• What problem is being solved and why it matters.
• Who is affected (users, systems, downstream services).
• Current behavior vs desired behavior.

2. Requirements

• Functional Requirements (numbered, testable)
  • FR-1: ...
  • FR-2: ...
• Non-Functional Requirements (numbered)