readme-generator

This skill should be used when users want to create or improve README.md files for their projects. It generates professional documentation following the Deep Insight/Strands SDK style - comprehensive yet focused, with clear structure and practical examples.

1. Zainstaluj umiejętność w swoim środowisku Claude Code lub Strands SDK, dodając ją do dostępnych narzędzi agenta.

2. Przygotuj projekt – upewnij się, że masz dostęp do katalogu z kodem, którym chcesz się dzielić w dokumentacji. Umiejętność będzie analizować strukturę plików i zawartość za pomocą natywnych narzędzi (Read, Glob, Grep).

3. Uruchom umiejętność z instrukcją, np. "Utwórz README.md dla mojego projektu" lub "Ulepsz mój istniejący README w stylu Deep Insight". Jeśli masz już plik README, możesz poprosić o jego modernizację.

4. Umiejętność przeanalizuje kod, wydobędzie kluczowe informacje i wygeneruje strukturę zgodnie ze wzorem Deep Insight: nagłówek z logiem, sekcja wartości, Quick Start, instalacja, architektura i sekcje dodatkowe.

5. Przejrzyj wygenerowany README – sprawdź, czy struktura jest logiczna, przykłady są jasne, a dokumentacja odpowiada Twoim potrzebom. W razie potrzeby poproś o poprawki konkretnych sekcji.

6. Zapisz plik README.md w katalogu głównym projektu. Możesz go dalej edytować ręcznie lub poprosić umiejętność o kolejne iteracje.