README projektu, który ktoś zrozumie

Napisz plik README.md dla mojego projektu.
Co robi projekt i dla kogo jest: [OPIS PROJEKTU].
Technologie i wymagania (wersje, rozszerzenia, usługi): [WYMAGANIA].
Jak się go instaluje i uruchamia (moje notatki, mogą być chaotyczne): [INSTALACJA].
Najważniejsze ustawienia lub zmienne środowiskowe: [KONFIGURACJA].

Struktura README:
1. nazwa i jedno zdanie, co to jest,
2. główne funkcje (3–6 punktów),
3. wymagania,
4. instalacja krok po kroku – każdy krok z poleceniem w bloku kodu,
5. konfiguracja (tabela: zmienna – opis – przykład),
6. przykład użycia,
7. najczęstsze problemy i rozwiązania,
8. struktura katalogów (krótko).
Pisz po polsku, konkretnie. Nie dopisuj funkcji, których nie podałem. Klucze i hasła pokazuj jako TWOJ_KLUCZ, nigdy prawdziwe.

Kiedy użyć tego promptu

Gdy kończysz projekt albo przekazujesz go komuś innemu – współpracownikowi, klientowi, czy sobie za pół roku. Brak README to najczęstszy powód, dla którego działający kod staje się „tym projektem, którego nikt nie umie uruchomić”. Model dobrze porządkuje chaotyczne notatki w czytelną instrukcję.

Przykład

Przykładowe dane do uzupełnienia:

• OPIS PROJEKTU: skrypt w PHP, który co noc pobiera zamówienia ze sklepu i wysyła raport do księgowości
• WYMAGANIA: PHP 8.1, rozszerzenia curl i mbstring, dostęp do API sklepu, serwer z cronem
• INSTALACJA: skopiować pliki, config.example.php → config.php, wpisać klucz API i mail, dodać crona 0 2 * * *
• KONFIGURACJA: SHOP_API_KEY, SHOP_URL, REPORT_EMAIL, TIMEZONE

Czego się spodziewać: Dostaniesz README z krótkim opisem, krokami instalacji w blokach kodu (łącznie z wpisem do crona), tabelą zmiennych z przykładami w stylu TWOJ_KLUCZ i sekcją problemów typu „raport nie przychodzi – sprawdź, czy cron działa i czy serwer może wysyłać maile”.

Jak dopasować prompt do siebie

• Projekt open source na GitHubie: dodaj sekcje „Jak pomóc w rozwoju” i „Licencja”.
• Projekt dla klienta: zamień sekcję techniczną na prostszą instrukcję obsługi i dodaj kontakt do wsparcia.
• Biblioteka lub API: poproś o sekcję z przykładami wywołań dla 3 najczęstszych przypadków.

Wskazówki

• Przejdź instalację według README na czystym środowisku – brakujący krok wyjdzie od razu.
• Wklej strukturę katalogów (np. wynik polecenia tree) – opis będzie dokładniejszy.
• Aktualizuj README przy każdej zmianie wymagań, inaczej szybko zacznie wprowadzać w błąd.

Najczęstsze błędy

• README z prawdziwymi kluczami API albo hasłami w przykładach.
• Instrukcja „zainstaluj zależności i uruchom” bez konkretnych poleceń.

Co dalej – dopytaj model

Gdy dostaniesz odpowiedź, możesz pójść krok dalej tym poleceniem:

Na podstawie tego README przygotuj krótką instrukcję wdrożenia na serwer produkcyjny: lista kontrolna przed uruchomieniem i co sprawdzić po.

Na podstawie poniższego opisu przygotuj specyfikację API.
Cel integracji: [CEL]
Systemy uczestniczące: [SYSTEMY]
Uwierzytelnianie: [SPOSÓB AUTH]
Opis funkcji lub istniejący kod: [MATERIAŁ].

Dla każdego endpointu opisz: metodę HTTP, ścieżkę, cel, wymagane uprawnienia, parametry ścieżki i zapytania, schemat body, przykładowe żądanie, przykładową odpowiedź, możliwe kody błędów, walidację, limity i skutki uboczne. Dodaj uwagi dotyczące idempotencji, paginacji i wersjonowania, jeśli mają zastosowanie.

Nie wymyślaj endpointów ani zachowania, którego nie ma w materiale. Braki oznacz jako pytania do zespołu. Przykłady muszą używać fikcyjnych danych i nie mogą zawierać prawdziwych sekretów.

Przygotuj przekierowania 301 dla [SERWER].

Lista: stary adres → nowy adres
[WKLEJ LISTĘ ADRESÓW]

Wymagania:
- sprawdź, czy nie ma łańcuchów (A→B→C) i pętli – jeśli są, popraw je,
- tam, gdzie wiele adresów ma wspólny wzór, zaproponuj jedną regułę zamiast wielu,
- zachowaj parametry w adresie, jeśli są potrzebne,
- podaj, jak sprawdzić, że przekierowania działają.

Napisz wyrażenie regularne dla [JĘZYK LUB NARZĘDZIE].
Ma dopasować: [CO MA PASOWAĆ].
Nie może dopasować: [CZEGO NIE MA DOPASOWAĆ].

Podaj:
- wyrażenie,
- wyjaśnienie każdej części w tabeli,
- 5 przykładów, które pasują, i 5, które nie pasują,
- jedno miejsce, w którym wyrażenie może zawieść.