Toolverse
Wszystkie skille

update-spec

autor: mindfold-ai

Dokumentuj decyzje projektowe i kontrakty kodu zaraz po implementacji

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend
Wyświetlenia
22

O skillu

Skill do aktualizacji specyfikacji kodu w trakcie pracy — zapisz to, czego się nauczyłeś podczas debugowania, implementacji lub dyskusji. Tworzy wykonalne kontrakty z konkretnymi sygnaturami, polami payload, zmiennymi środowiska i zachowaniem na granicach. Obowiązkowy dla zmian infrastruktury i kontraktów między warstwami. Zawiera sekcje: zakres, sygnatury, walidacja, przypadki testowe i typowe błędy.

Jak używać

  1. Po ukończeniu zadania, naprawieniu błędu lub odkryciu nowego wzorca uruchom skill update-spec, aby zaktualizować odpowiedni dokument code-spec w projekcie.

  2. Zidentyfikuj typ zmian: implementacja funkcji, decyzja projektowa, naprawa błędu, odkryty wzorzec, gotcha lub konwencja zespołu. To określi, które sekcje spec należy zmienić.

  3. Dla zmian infrastruktury lub kontraktów między warstwami upewnij się, że spec zawiera wszystkie wymagane sekcje: zakres/wyzwalacz, sygnatury (API/komenda/baza), kontrakty (request/response/zmienne), macierz walidacji i błędów, przypadki testowe (dobre/bazowe/złe) oraz co najmniej jedną parę przykładów "błędnie vs poprawnie".

  4. Dodaj konkretne szczegóły: nazwy pól, typy danych, klucze środowiska, zachowanie brzegowe i warunki błędu. Unikaj ogólnych opisów — spec musi być testowalna.

  5. Jeśli zmiana dotyczy nowego wzorca lub gotchy, dodaj sekcję "Design Decisions" lub "Common Mistakes" z praktycznym poradnikiem dla zespołu.

  6. Upewnij się, że każdy kontrakt w spec ma odpowiadające mu testy z punktami asercji — spec bez testów nie jest wykonalnym kontraktem.

Podobne skille