Dokumentuje tworzoną aplikację

Dlaczego tak

CSS ma tylko jeden rodzaj komentarza: tekst między /* a */, który może obejmować jeden lub wiele wierszy. Zapis // znany z JavaScriptu i PHP nie jest komentarzem w CSS — przeglądarka potraktuje taki wiersz jako błędną deklarację i go odrzuci, a postawiony przed selektorem unieważniłby całą następną regułę. <!-- --> to komentarz HTML, a # rozpoczyna komentarz w PHP lub Pythonie.

Dlaczego tak

README to pierwszy dokument, który czyta nowa osoba w projekcie: opisuje, do czego służy program, czego wymaga (np. wersja PHP, baza danych) i jak go zainstalować, skonfigurować i uruchomić. Hasła nigdy nie trafiają do repozytorium — umieszcza się je w zmiennych środowiskowych lub plikach wyłączonych z kontroli wersji. Historię zmian przechowuje system kontroli wersji, a kod jest w plikach źródłowych.

Dlaczego tak

Instrukcja użytkownika odpowiada na pytanie „jak to zrobić”: prowadzi krok po kroku przez zadania klienta, takie jak rejestracja, złożenie zamówienia czy zwrot towaru, językiem bez żargonu, z ilustracjami ekranów. Opis bazy danych, klas, kodu i konfiguracji serwera to dokumentacja techniczna — przydatna programistom i administratorom, ale niezrozumiała dla klienta.