crafting-effective-readmes

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

1. Uruchom umiejętność, gdy pracujesz nad plikiem README. Narzędzie zapyta, jaki rodzaj zadania wykonujesz: tworzenie nowego README, dodawanie sekcji, aktualizowanie zawartości czy przegląd istniejącego dokumentu.
2. Odpowiedz na pytania dotyczące Twojego projektu. Jeśli tworzysz nowe README, określ typ projektu (open source, osobisty, wewnętrzny), opisz problem, który rozwiązujesz w jednym zdaniu, i wskaż najszybszą ścieżkę do działającego rozwiązania. Dla innych zadań podaj szczegóły dotyczące zmian lub sekcji, którą chcesz dokumentować.
3. Otrzymaj szablon i wskazówki dopasowane do Twojej sytuacji. Narzędzie zaproponuje strukturę README i konkretne sekcje odpowiednie dla Twojej publiczności (współtwórcy, użytkownicy, przyszły Ty).
4. Przejrzyj proponowany tekst i dostosuj go do swoich potrzeb. Jeśli aktualizujesz istniejący README, porównaj go z rzeczywistym stanem projektu (package.json, główne pliki) i zidentyfikuj przestarzałe sekcje.
5. Poproś o dodatkowe sugestie. Po wstępnym szkicu zapytaj: "Czy jest coś jeszcze, co powinienem uwzględnić lub podkreślić?", aby upewnić się, że README odpowiada na wszystkie pytania odbiorcy.
6. Zaktualizuj datę ostatniego przeglądu, jeśli Twój README ją zawiera, aby odzwierciedlić bieżący stan dokumentacji.