Przejdź do treści
Nodary
Zacznij za darmo

Szablon rejestru decyzji z ADR

Rejestr decyzji i jego wpisy w sześciu połączonych dokumentach: rejestr z każdą decyzją i jej statusem, sposób, w jaki twój zespół decyduje, pusty wpis do skopiowania i trzy przykładowe wpisy, z których jeden został zastąpiony przez następny. Pobierz je jako pliki Markdown: otworzysz je w dowolnym edytorze, pasują do repozytorium kodu, a do Nodary zaimportujesz je jako mapę.

Pobierz szablonOtwórz demo

6 plików Markdown w archiwum .zip, 7 kB

Za darmo, bez konta, bez e-maila. Używaj, zmieniaj, udostępniaj.

Rejestr decyzjiJak decydujemyPusty wpis decyzjiADR-001 Zapisujemy decyzje w tym rejestrzeADR-002 Przechowywanie przesłanych plików na serwerze aplikacjiADR-003 Przechowywanie przesłanych plików w magazynie obiektów

Przeczytaj każdą stronę przed pobraniem

Rejestr to strona, którą otwierają wszyscy: jeden wiersz na decyzję, połączony z jej wpisem. Wpisy mają format ADR (architecture decision record) i nadają się do każdej decyzji, technicznej lub nie. Przykłady dotyczą jednego przykładowego produktu, który decyduje, gdzie przechowywać przesłane pliki.

Dokumenty

Plik Szablon rejestru decyzji/Rejestr decyzji.md

Rejestr decyzji

Jak korzystać z szablonu: wiersze kursywą to wskazówki. Zastąp je własnymi słowami, a potem usuń. Wartości w nawiasach kwadratowych uzupełniasz sam. Każda decyzja ma własny wpis, połączony z tabelą poniżej; wpisu nigdy się nie usuwa, a decyzja, która się zmienia, dostaje nowy wpis, który ją zastępuje.

Decyzje

NumerDecyzjaStatusDataKto zdecydowałZastąpiona przez
ADR-001Zapisujemy decyzje w tym rejestrzeprzyjęta[data][nazwiska]
ADR-002Przechowywanie przesłanych plików na serwerze aplikacjizastąpiona[data][nazwiska]ADR-003
ADR-003Przechowywanie przesłanych plików w magazynie obiektówprzyjęta[data][nazwiska]
[ADR-004][Twoja następna decyzja][proponowana][data][nazwiska]

Statusy

  • ProponowanaPrzyjętaOdrzucona
  • PrzyjętaZastąpionaNieaktualna
Jak zmienia się status decyzjiDiagram Mermaid w pliku: rysują go Nodary, GitHub i Obsidian.
Mermaid
flowchart LR
  n0["Proponowana"]
  n1["Przyjęta"]
  n2["Odrzucona"]
  n3["Zastąpiona"]
  n4["Nieaktualna"]
  n0 --> n1
  n0 --> n2
  n1 --> n3
  n1 --> n4
StatusZnaczenie
ProponowanaZapisana i otwarta do przeglądu, jeszcze nierozstrzygnięta
PrzyjętaRozstrzygnięta: zespół się jej trzyma
OdrzuconaRozstrzygnięta na nie i zachowana, żeby nikt nie musiał pytać ponownie
ZastąpionaZastąpiona przez późniejszą decyzję, której numer podaje
NieaktualnaJuż nie obowiązuje i nic jej nie zastąpiło

Kiedy pisać wpis

  • Decyzję trudno cofnąć: [baza danych, dostawca, publiczne API, cena]
  • Poważnie rozważano kilka opcji
  • Ktoś za pół roku zapyta dlaczego
  • Zmienia pracę innego zespołu

Reszta rejestru

Z tego szablonu możesz swobodnie korzystać, a także go zmieniać i udostępniać. Pochodzi z Nodary, gdzie te pliki importują się jako mapa połączonych dokumentów.

Pobierz szablon6 plików Markdown w archiwum .zip, 7 kB

Jak z niego korzystać

  1. Ustalcie, kto decyduje

    Najpierw wypełnij stronę procesu: które decyzje wymagają wpisu, kto proponuje, kto decyduje i kogo się konsultuje.

  2. Kopiuj wpis dla każdej decyzji

    Nadaj mu kolejny numer i status „proponowana”. Opisz kontekst i co najmniej dwie opcje, zanim ktokolwiek zapisze decyzję.

  3. Zdecyduj, potem dopisz do rejestru

    Zmień status na „przyjęta” albo „odrzucona”, z datą i osobami, które zdecydowały, i dodaj wiersz do rejestru. Odrzucona decyzja zostaje: oszczędza następną dyskusję.

  4. Zastępuj, nigdy nie przepisuj

    Gdy decyzja się zmienia, napisz nowy wpis, który zastępuje stary, i oznacz stary jako zastąpiony, z nowym numerem. Historia pozostaje czytelna.

Zaimportuj go do Nodary jako mapę

Nodary to przestrzeń robocza oparta na AI, w której dokumenty zespołu łączą się ze sobą, zamiast się piętrzyć. Zaimportuj .zip, a rejestr pojawi się z wpisami pod sobą i z zachowanymi linkami między nimi. Oznacz każdy wpis jako Kanon, Eksploracja, Nieaktualne albo Zastąpione przez wpis, który go zastąpił: status widać na dokumencie, a agenci AI połączeni przez MCP dowiadują się o nim, zanim przeczytają zastąpiony wpis. Gdy dwa dokumenty sobie przeczą, Nodary pokazuje oba fragmenty obok siebie.

  1. Otwórz mapę projektu i wybierz „Importuj”.
  2. Wybierz kartę „Folder lub ZIP”, a potem „Wybierz plik ZIP”.
  3. Wskaż pobrany plik, sprawdź drzewo i zaimportuj.

Plan Free mieści dziesięć dokumentów na przestrzeń roboczą, wliczając stronę samego projektu: sześć dokumentów szablonu zostawia miejsce na trzy kolejne wpisy. Nodary ma też wbudowany jednostronicowy szablon Architecture Decision Record.

Jak agenci AI łączą się z Nodary przez MCP
Dokument w Nodary z notatką o tym, co zmieniło się od ostatniej wizyty czytelnika i kto to zmienił, oraz historia wersji porównująca tamtą wersję z obecną; pokazany przykładowy projekt to gra.

Jak prowadzić rejestr decyzji, któremu się ufa

Rejestr decyzji zawodzi, gdy nikt w nim nie pisze albo gdy to, co mówi, nie zgadza się już z tym, co robi zespół. Te nawyki zapobiegają obu sytuacjom.

Jedna decyzja na wpis

Wpis, który rozstrzyga trzy sprawy, jest otwierany trzy razy. Ogranicz każdy do jednej decyzji z jednym statusem.

Kontekst przed decyzją

Zapisz, co jest dziś prawdą i co ogranicza wybór, zanim zapiszesz samą decyzję. Po pół roku to kontekst ją wyjaśnia.

Zawsze dwie opcje

Wpis z jedną opcją to ogłoszenie. Nazwij alternatywy, które naprawdę rozważaliście, i powiedz, dlaczego ich nie wybraliście.

Zastępuj, nigdy nie przepisuj

Przyjętego wpisu nigdy się nie edytuje, żeby mówił coś innego. Nowy wpis go zastępuje i oba zostają, więc rejestr opowiada prawdziwą historię.

Powiedz, kto zdecydował

Każdy wpis wymienia osoby, które zdecydowały, i datę. Decyzja bez nazwiska nie ma nikogo, kogo można zapytać, ani nikogo, kto mógłby ją zmienić.

Linkuj to, co zmienia

Połącz każdy wpis z dokumentami, które zmienia, a te dokumenty z nim. Czytelnik projektu znajdzie wtedy powód jednym kliknięciem.

Pytania o rejestr decyzji

Czym jest rejestr decyzji?

Rejestr decyzji to bieżąca lista ważnych decyzji zespołu: co postanowiono, kiedy, kto, jaki jest status i link do wpisu, który to wyjaśnia. Dzięki niemu każdy, także nowa osoba w zespole albo agent AI, dowie się, dlaczego rzeczy są takie, jakie są, bez wypytywania wszystkich.

Czym jest ADR?

ADR (architecture decision record, zapis decyzji architektonicznej) to krótki dokument dla jednej ważnej decyzji: jej kontekst, rozważane opcje, decyzja i jej skutki, z numerem i statusem. Format pochodzi z architektury oprogramowania i sprawdza się przy każdej decyzji, którą zespół chce zachować.

Co znaczy „zastąpiona”?

Zastąpiona decyzja została zastąpiona późniejszą. Zostaje w rejestrze bez zmian, z numerem wpisu, który ją zastąpił, a nowy wpis mówi, który zastępuje. Nic nie jest usuwane, więc historia pozostaje prawdziwa.

Kiedy zespół powinien pisać wpis decyzji?

Gdy decyzję trudno cofnąć, gdy rozważano poważnie kilka opcji, gdy zmienia pracę innego zespołu albo gdy ktoś za pół roku zapyta dlaczego. Małe, odwracalne wybory nie potrzebują wpisu.

Czy wpisy decyzji powinny żyć przy kodzie, czy przy dokumentach?

Zespoły, które dzielą się decyzjami tylko między programistami, często trzymają je w repozytorium kodu. Gdy muszą je czytać także produkt, projektanci, wsparcie albo klienci, łatwiej je znaleźć we wspólnej przestrzeni roboczej. Pliki tego szablonu działają w obu miejscach.

Czy mogę używać go poza Nodary?

Tak. Pliki to Markdown z linkami względnymi: umieść folder w repozytorium, otwórz go jako sejf w Obsidianie albo czytaj na GitHubie, razem z diagramem.

Czytaj dalej

Trzymaj każdą decyzję tam, gdzie pracuje zespół.

Zaimportuj szablon do Nodary, a rejestr stanie się mapą, która mówi twojemu zespołowi i twoim agentom AI, które decyzje wciąż obowiązują. Za darmo dla dwóch członków, jednego projektu i dziesięciu dokumentów, bez karty.

Zacznij za darmoOtwórz demoPobierz szablon