README section generator prompt for developers

Generate a clear, scannable README section such as installation, usage, or contributing, with a working code example.

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

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

  • When publishing a new open-source repo.
  • When an existing README is missing a section like Configuration.
  • When standardizing README structure across team projects.

نص البرومبت

Write a {{focus}} section for a README.md, for a {{language}} project using {{framework}}. Keep it clear, scannable, and include a code example where relevant.

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

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

كيف تستخدمه

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

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

## Installation

```bash
npm install my-package
```

Requires Node.js 18+. After installing, import it directly:

```js
import { parse } from 'my-package';
```

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

  • Set the focus field to the exact section name (Installation, Usage, Contributing, Configuration).
  • Paste your actual package.json or setup commands for accuracy.
  • Ask for badges (build status, license) only if you already have the URLs to back them.

أسئلة شائعة

Can it write the whole README at once?
Yes, run it once per section (Installation, Usage, Contributing, etc.) for more focused, higher-quality results than one giant prompt.
Will it invent features my project doesn't have?
It only documents what you paste or describe; be specific about actual behavior to avoid generic filler.

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

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}}
المزيد في برمجة ←