Skip to content

Update design.prompt.md to encourage concise "Why" rationale with ADR/Constitution links#8

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/update-design-document-summary
Draft

Update design.prompt.md to encourage concise "Why" rationale with ADR/Constitution links#8
Copilot wants to merge 2 commits intomainfrom
copilot/update-design-document-summary

Conversation

Copy link
Copy Markdown

Copilot AI commented Nov 27, 2025

Nudges design documents toward recording reasons for choices while keeping documents short and actionable. Adds lightweight linking to ADRs and CONSTITUTION.md instead of duplicating policy text.

Changes

  • Top summary: Clarified document captures "HOW + short WHY" with optional links
  • Design Consideration template: Replaced Rationale: with Why (1 line): field
  • Example (Upload Profile Picture): Added sample "Why" entries with link references
  • Final Instructions: Added item 6 with guidance on concise rationale and link formats

Example template change

### [Design Consideration]
**Approach:** [What we'll try first]  
**Why (1 line):** [Concise reason; can reference (see: CONSTITUTION.md#section) or (ADR: YYYY-MM-DD-title)]  
**Trade-offs:** [What we're accepting vs. what we're gaining]  
**Alternatives to Consider:** [Other approaches we might pivot to]
Original prompt

Make a minimal, focused update to design.prompt.md to encourage designers to include a concise "why" for chosen approaches, plus lightweight linking to relevant ADRs and CONSTITUTION.md without duplicating long texts. The goal is to nudge designs slightly toward recording reasons for choices while keeping documents short and actionable.

Required changes (edit design.prompt.md):

  1. Update the top summary paragraph (currently: "This document represents the HOW (Initial) - sketching initial design ideas...") to clarify the document should be an initial HOW plus a short WHY: one-line rationale for each key consideration and optional links to ADRs or CONSTITUTION.md entries.

  2. In "Design Document Structure" section, under the template for each "Design Consideration", add a new line/field called "Why (1 line):" directly after "Rationale:" or replace Rationale with shorter fields. The new fields should be:

    • Approach: [What we'll try first]
    • Why (1 line): [Concise reason for choosing this approach; can reference ADR or CONSTITUTION.md by path or short id]
    • Trade-offs: [What we're accepting vs. what we're gaining]
    • Alternatives to Consider: [...]

    Emphasize the Why must be 1-2 short sentences and include an optional link like "(see: CONSTITUTION.md#security-auth)" or "(ADR: 2025-03-01-auth-strategy)".

  3. Update the example template (Upload Profile Picture) to show the new "Why (1 line)" field populated with a short example and a sample link to CONSTITUTION.md.

  4. Add a short note in "Final Instructions" (or nearby) that designers should "Add 1-line 'Why' for each key consideration and include a link to an ADR or CONSTITUTION.md if applicable. Keep the 'Why' concise — no long policy text." Also include guidance: "Prefer referencing existing ADRs/Constitution entries instead of copying their content. Use simple link forms like '(see CONSTITUTION.md#section)' or '(ADR: YYYY-MM-DD-title)'."

  5. Keep all other content and structure intact. Maintain existing formatting and examples. Do not add implementation code. Keep changes lightweight and focused on documentation guidance.

Make the change as a single commit on a new branch and open a pull request titled with the problem_title. Include a brief PR description summarizing the edits and rationale.

Do not modify other files.

This pull request was created as a result of the following prompt from Copilot chat.

Make a minimal, focused update to design.prompt.md to encourage designers to include a concise "why" for chosen approaches, plus lightweight linking to relevant ADRs and CONSTITUTION.md without duplicating long texts. The goal is to nudge designs slightly toward recording reasons for choices while keeping documents short and actionable.

Required changes (edit design.prompt.md):

  1. Update the top summary paragraph (currently: "This document represents the HOW (Initial) - sketching initial design ideas...") to clarify the document should be an initial HOW plus a short WHY: one-line rationale for each key consideration and optional links to ADRs or CONSTITUTION.md entries.

  2. In "Design Document Structure" section, under the template for each "Design Consideration", add a new line/field called "Why (1 line):" directly after "Rationale:" or replace Rationale with shorter fields. The new fields should be:

    • Approach: [What we'll try first]
    • Why (1 line): [Concise reason for choosing this approach; can reference ADR or CONSTITUTION.md by path or short id]
    • Trade-offs: [What we're accepting vs. what we're gaining]
    • Alternatives to Consider: [...]

    Emphasize the Why must be 1-2 short sentences and include an optional link like "(see: CONSTITUTION.md#security-auth)" or "(ADR: 2025-03-01-auth-strategy)".

  3. Update the example template (Upload Profile Picture) to show the new "Why (1 line)" field populated with a short example and a sample link to CONSTITUTION.md.

  4. Add a short note in "Final Instructions" (or nearby) that designers should "Add 1-line 'Why' for each key consideration and include a link to an ADR or CONSTITUTION.md if applicable. Keep the 'Why' concise — no long policy text." Also include guidance: "Prefer referencing existing ADRs/Constitution entries instead of copying their content. Use simple link forms like '(see CONSTITUTION.md#section)' or '(ADR: YYYY-MM-DD-title)'."

  5. Keep all other content and structure intact. Maintain existing formatting and examples. Do not add implementation code. Keep changes lightweight and focused on documentation guidance.

Make the change as a single commit on a new branch and open a pull request titled with the problem_title. Include a brief PR description summarizing the edits and rationale.

Do not modify other files.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Update design.prompt.md to include concise 'why' for design choices Update design.prompt.md to encourage concise "Why" rationale with ADR/Constitution links Nov 27, 2025
Copilot AI requested a review from co0p November 27, 2025 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants