Toolverse
Wszystkie skille

adr-documentation

autor: MadAppGang

Dokumentuj decyzje architektoniczne w zespole — zachowaj kontekst i unikaj powtarzania błędów

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend
Wyświetlenia
1

O skillu

Skill do tworzenia Architecture Decision Records (ADR) — lekkich dokumentów, które rejestrują ważne decyzje architektoniczne wraz z ich kontekstem, rozpatrzonymi alternatywami i konsekwencjami. Pomaga zespołom zachować wiedzę instytucjonalną, przyspieszać onboarding nowych deweloperów i unikać ponownego rozpatrywania już rozstrzygniętych kwestii. Każdy ADR staje się niezmiennym rekordem historycznym — zamiast edytować, tworzy się nowe wersje.

Jak używać

  1. Aktywuj skill adr-documentation w swoim Claude'ie lub agencie — będzie gotowy do pracy, gdy w konwersacji pojawią się słowa kluczowe takie jak "ADR", "architektoniczne", "decyzja", "trade-offy" lub "log decyzji".

  2. Kiedy potrzebujesz udokumentować decyzję architektoniczną, opisz problem, który rozwiązujesz — na przykład wybór między monolitem a architekturą mikroserwisów, decyzję o frameworku lub strategię skalowania bazy danych.

  3. Skill pomoże Ci zebrać kontekst: jakie były ograniczenia, jakie opcje rozpatrywaliście i dlaczego odrzuciliście alternatywy. Dokumentuj zarówno to, co wybraliście, jak i to, co rozważaliście — ta wiedza jest cenna dla przyszłych zespołów.

  4. Stwórz ADR jako lekki dokument — nie musi być długi. Zawrze powinien: stan problemu, rozpatrzone rozwiązania, wybrane rozwiązanie i jego konsekwencje. Skill będzie Ci podpowiadać strukturę.

  5. Traktuj zaakceptowany ADR jako niezmienną historię decyzji. Jeśli sytuacja się zmieni i trzeba zmienić podejście, nie edytuj starego ADR — zamiast tego stwórz nowy dokument, który go superseduje i wyjaśnia, dlaczego zmiana była konieczna.

  6. Zachowuj ADRy w repozytorium projektu (np. w folderze docs/adr/) — będą dostępne dla nowych członków zespołu, którzy chcą zrozumieć ewolucję systemu i przyczyny obecnych wyborów.

Podobne skille