backend-to-frontend-handoff-docs
Create API handoff documentation for frontend developers. Use when backend work is complete and needs to be documented for frontend integration, or user says 'create handoff', 'document API', 'frontend handoff', or 'API documentation'.
Installation
Pick a client and clone the repository into its skills directory.
Installation
About this skill
Create API handoff documentation for frontend developers. Use when backend work is complete and needs to be documented for frontend integration, or user says 'create handoff', 'document API', 'frontend handoff', or 'API documentation'.
How to use
Przygotuj ukończony kod API — upewnij się, że wszystkie endpointy, kontrolery, serwisy i DTO są gotowe do dokumentacji.
Zgromadź kontekst biznesowy — zbierz informacje o nazwie feature'a, powiązanych endpointach, regułach autoryzacji, ograniczeniach i znanych edge case'ach odkrytych podczas implementacji.
Uruchom umiejętność — użyj komendy 'create handoff', 'document API', 'frontend handoff' lub 'API documentation' w kontekście ukończonej pracy backendowej.
Umiejętność wygeneruje dokument handoff w formacie markdown — zawiera on strukturalny opis wszystkich endpointów, DTOs, reguł walidacji i przykładów payload'ów, które frontend potrzebuje do budowy integracji.
Dla prostych API (CRUD bez złożonej logiki biznesowej) umiejętność może pominąć pełny szablon i dostarczyć tylko endpoint, metodę HTTP i przykłady request/response — frontend może resztę wywnioskować z dokumentacji.
Jeśli potrzebujesz aktualizacji dokumentacji po feedback'u — uruchom umiejętność ponownie, a nowa wersja będzie zapisana z przyrostkiem wersji (v2, v3 itd.).