Toolverse
Wszystkie skille

decisions

autor: recyclarr

Skill do tworzenia i edycji dokumentów decyzji architektonicznych i produktowych

Instalacja

Wybierz klienta i sklonuj repozytorium do odpowiedniego katalogu skilli.

Instalacja

Szybkie info

Kategoria
Backend
Wyświetlenia
24

O skillu

Proceduralna wiedza dla zespołów pracujących z ADR (Architecture Decision Records) i PDR (Product Decision Records) w katalogu docs/decisions/. Skill zawiera szablony obowiązkowe, reguły nazewnictwa, zarządzanie statusami decyzji oraz wytyczne, kiedy tworzyć ADR (wybory implementacyjne, wzorce) a kiedy PDR (zmiany upstream, zakres funkcji). Każda decyzja jest niezależnie śledzona, referencjonowana i może być zastąpiona.

Jak używać

  1. Przed utworzeniem lub edycją jakiegokolwiek dokumentu decyzji przeczytaj odpowiedni szablon: docs/decisions/architecture/TEMPLATE.md dla ADR lub docs/decisions/product/TEMPLATE.md dla PDR — szablony są obowiązkowe.

  2. Ustal typ decyzji: użyj ADR dla wyborów implementacyjnych, wzorców i kompromisów długoterminowych; użyj PDR dla zmian upstream, zakresu funkcji i zewnętrznych sterowników.

  3. Nazwij plik zgodnie z konwencją NNN-kebab-case-title.md, gdzie NNN to sekwencyjny numer w danej kategorii, a tytuł opisuje decyzję w formie łańcucha ze znakami minus.

  4. Ustaw datę decyzji na dzień, kiedy decyzja została faktycznie podjęta, a nie kiedy została udokumentowana — dla istniejących decyzji zweryfikuj historię git za pomocą git log --format="%ai" commit -1.

  5. Przypisz status decyzji: proposed (rozpatrywana), accepted (sfinalizowana), deprecated (nieaktualna) lub superseded by {ADR,PDR}-NNN (zastąpiona inną decyzją).

  6. Dla PDR upewnij się, że pole upstream zawiera link do zewnętrznego sterownika — może to być zmiana schematu, API lub decyzja z upstream projektu.

Podobne skille