Skip to content

Don't write code in design doc #649

@LukeLIN-web

Description

@LukeLIN-web

Describe the bug

The brainstorming skill's design doc output (saved to
docs/plans/YYYY-MM-DD--design.md) often includes inline code blocks and code snippets
(Python, bash, etc.). Design docs should focus on ideas, architecture, and rationale — not
implementation details that belong in the implementation plan phase.

To Reproduce

  1. Start a new session and describe a feature to build
  2. Go through the brainstorming flow (clarifying questions → approach selection → design)
  3. Approve the design
  4. The skill writes the design doc to docs/plans/
  5. The resulting .md file contains code blocks (python, bash, etc.) with
    implementation snippets

Expected behavior

The design doc should only contain:

  • Design ideas and architecture
  • Component descriptions and data flow
  • Trade-offs and rationale
  • Success criteria

Code blocks and file paths should be deferred to the implementation plan (via the
writing-plans skill), not embedded in the design doc. File paths in design docs also go
stale when files are moved.

Additional context

The writing-plans skill already exists as the next step after brainstorming specifically for
implementation details. Having code in both the design doc and the implementation plan
creates duplication and makes design docs harder to read as high-level references.

A simple fix would be adding a rule to the "Presenting the design" section in
skills/brainstorming/SKILL.md:

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions