Files
breedr/.zenflow/tasks/init-9c68/plan.md
Zenflow 2daccf7d8c INIT (zenflow 9c6862b8)
Scan the code, build the .md files you need to make it easier for the agent to preform modifications and fix bugs
2026-03-11 09:51:35 -05:00

3.9 KiB

Full SDD workflow

Configuration

  • Artifacts Path: {@artifacts_path} → .zenflow/tasks/{task_id}

Agent Instructions

If you are blocked and need user clarification, mark the current step with [!] in plan.md before stopping.


Workflow Steps

[x] Step: Requirements

Create a Product Requirements Document (PRD) based on the feature description.

  1. Review existing codebase to understand current architecture and patterns
  2. Analyze the feature definition and identify unclear aspects
  3. Ask the user for clarifications on aspects that significantly impact scope or user experience
  4. Make reasonable decisions for minor details based on context and conventions
  5. If user can't clarify, make a decision, state the assumption, and continue

Save the PRD to {@artifacts_path}/requirements.md.

[x] Step: Technical Specification

Create a technical specification based on the PRD in {@artifacts_path}/requirements.md.

  1. Review existing codebase architecture and identify reusable components
  2. Define the implementation approach

Save to {@artifacts_path}/spec.md with:

  • Technical context (language, dependencies)
  • Implementation approach referencing existing code patterns
  • Source code structure changes
  • Data model / API / interface changes
  • Delivery phases (incremental, testable milestones)
  • Verification approach using project lint/test commands

[x] Step: Planning

Create a detailed implementation plan based on {@artifacts_path}/spec.md.

  1. Break down the work into concrete tasks
  2. Each task should reference relevant contracts and include verification steps
  3. Replace the Implementation step below with the planned tasks

Rule of thumb for step size: each step should represent a coherent unit of work (e.g., implement a component, add an API endpoint). Avoid steps that are too granular (single function) or too broad (entire feature).

Important: unit tests must be part of each implementation task, not separate tasks. Each task should implement the code and its tests together, if relevant.

If the feature is trivial and doesn't warrant full specification, update this workflow to remove unnecessary steps and explain the reasoning to the user.

Save to {@artifacts_path}/plan.md.

[x] Phase 1: Create DEVELOPMENT.md

  1. Research tech stack, monorepo structure, and database schemas in server/db/.
  2. Document the "Parents Table" approach and database initialization/migration.
  3. Add setup and development commands.
  4. Verify correctness against server/db/init.js and package.json.

[x] Phase 2: Create API.md

  1. Research all routes in server/routes/ for endpoints, methods, parameters, and responses.
  2. Document endpoint groups: Dogs, Litters, Health, Genetics, Breeding, and Settings.
  3. Provide JSON schema examples for key data models (Dog, Litter, etc.).
  4. Verify endpoints against route handlers in server/routes/.

[x] Phase 3: Create FRONTEND_GUIDE.md

  1. Research React patterns, hooks (useSettings), and PedigreeTree logic.
  2. Document routing, state management, and key reusable components (DogForm, PedigreeTree, etc.).
  3. Explain styling conventions and theme implementation using CSS variables.
  4. Verify patterns against client/src/App.jsx, client/src/hooks/, and client/src/components/.

[x] Phase 4: Final Review and Verification

  1. Cross-reference all new documentation files with the current codebase (v0.6.1).
  2. Ensure consistent formatting and clarity across all three files.
  3. Verify that an agent can understand how to implement a new feature using only these documents.