Architecture decision record (ADR) generator prompt

Describe a technical decision and get a structured ADR document covering context, alternatives, and consequences.

بواسطة ‪Ahmed Eid‬‏Claude0 نسخة

متى تستخدم هذا البرومبت

  • When choosing between two frameworks, databases, or patterns for a project.
  • When documenting why a past decision was made, for future maintainers.
  • When a decision needs sign-off and a written record.

نص البرومبت

Write an Architecture Decision Record for the decision: {{focus}}. Include context, the decision, alternatives considered, and consequences. Project context: {{language}}/{{framework}}.

{{CLIPBOARD}}
{{focus}}{{language}}{{framework}}{{CLIPBOARD}}

الكتلة {{CLIPBOARD}} تُستبدل تلقائياً بما نسخته قبل الضغط على «نسخ».

كيف تستخدمه

  1. انسخ البرومبت بالزر أو املأ المتغيرات أولاً.
  2. الصقه في ChatGPT أو Claude أو Gemini.
  3. عدّل النتيجة أو أعد الطلب بتغيير المتغيرات.

مثال على النتيجة

# ADR 007: Use PostgreSQL over MongoDB for order data

## Context
Order data is relational with strict consistency needs across payments and inventory.

## Decision
Use PostgreSQL with foreign key constraints.

## Alternatives considered
MongoDB, rejected due to weaker cross-collection consistency guarantees.

## Consequences
Requires schema migrations for changes; gains ACID transactions across orders and inventory.

نصائح للاستخدام

  • Describe the real alternatives you considered, not just the chosen option, for a fair record.
  • Include constraints like team skills, budget, or timeline that shaped the decision.
  • Store the finished ADR in a docs/adr folder with a sequential number for traceability.

النماذج الموصى بها

Claude

أسئلة شائعة

Do I need to already know the outcome before writing this?
Yes, ADRs record decisions already made or being finalized; for exploring options first, ask for a comparison instead.
How long should an ADR be?
Keep it to one page; the prompt defaults to that length unless you ask for more detail.

برومبتات ذات صلة

Generate a GraphQL Schema from a Description

Describe your data and operations in plain English and get a complete, documented GraphQL schema.

Design a GraphQL schema (types, queries, mutations) for: {{focus}}. Use {{language}} conventions and include field-level descriptions. {{CLIPBOARD}}

{{focus}}{{language}}{{CLIPBOARD}}

Generate Realistic Mock Data for Testing

Get realistic, varied mock data, including edge cases, matched to your schema, ready to seed a test database.

Generate {{focus}} realistic mock/test data records in {{language}} format for this schema or type, with varied and edge-case values. {{CLIPBOARD}}

{{focus}}{{language}}{{CLIPBOARD}}

Explain What This Legacy Code Actually Does

Paste unfamiliar or legacy code and get a plain-language walkthrough, with dead code and possible bugs flagged.

Walk through this {{language}} code line by line and explain what it does, in plain language. Flag anything that looks like dead code, a workaround, or a potential bug. {{CLIPBOARD}}

{{language}}{{CLIPBOARD}}

Generate a Dockerfile for Your App

Get a secure, optimized Dockerfile tailored to your language and framework, ready to build and run.

Write a production-ready Dockerfile for a {{language}} app using {{framework}}. Use multi-stage builds where useful, minimize image size, and run as a non-root user. Notes: {{focus}}. {{CLIPBOARD}}

{{language}}{{framework}}{{focus}}{{CLIPBOARD}}
المزيد في برمجة ←