Skip to content

Prevent code blocks and file paths in brainstorming design docs #671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pratyush618 wants to merge 1 commit into from
Closed

Prevent code blocks and file paths in brainstorming design docs #671

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions skills/brainstorming/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ digraph brainstorming {
- Ask after each section whether it looks right so far
- Cover: architecture, components, data flow, error handling, testing
- Be ready to go back and clarify if something doesn't make sense
- **No code blocks or file paths** — design docs describe ideas and architecture, not implementation. Code snippets and specific file paths belong in the implementation plan (writing-plans), not the design doc. File paths in design docs go stale when files are moved.

**Design for isolation and clarity:**

Expand All @@ -105,6 +106,7 @@ digraph brainstorming {
- (User preferences for spec location override this default)
- Use elements-of-style:writing-clearly-and-concisely skill if available
- Commit the design document to git
- **Design docs must not contain code blocks or specific file paths.** Keep them focused on ideas, architecture, component descriptions, data flow, trade-offs, and success criteria. Implementation details go in the writing-plans output, not here.

**Spec Review Loop:**
After writing the spec document:
Expand Down