Czym jest szablon wymagań API?
Wspólny szablon planowania API, który pomaga zespołom produktowym, inżynieryjnym i architektonicznym określić potrzeby API przed rozpoczęciem prac deweloperskich. Warsztat obejmuje pięć etapów: zbieranie informacji o API, analizę wpływu na architekturę, tworzenie user stories, dokumentowanie wymagań technicznych i zależności oraz opracowanie roadmapy wdrożeniowej.
Jaki problem rozwiązuje szablon wymagań API?
Niekompletne wymagania API
Niejasne wymagania dotyczące integracji
Brak kontekstu architektonicznego
Brak spójności między potrzebami użytkowników a wymaganiami technicznymi
Ukryte zależności
Słaba zgodność między zespołem produktowym a inżynierią
Niejasna kolejność wdrażania
Jak używać szablonu wymagań API
Zacznij od zebrania informacji o API, interesariuszy, systemów i potrzeb biznesowych.
Przeanalizuj wpływ na architekturę i zmapuj połączenia między systemami, usługami i integracjami.
Stwórz user stories, które opisują, czego użytkownicy, systemy lub zespoły wewnętrzne potrzebują od API.
Udokumentuj wymagania techniczne, zależności, potrzeby w zakresie bezpieczeństwa, kwestie dotyczące danych oraz ograniczenia integracji.
Na koniec uporządkuj wymagania w roadmapie z priorytetami, kamieniami milowymi i kolejnością wdrażania.
Typowe pułapki
Rozpoczęcie prac przed jasnym określeniem celu API
Dokumentowanie endpointów bez zrozumienia potrzeb użytkowników
Pominięcie analizy wpływu na architekturę
Ignorowanie zależności między systemami
Brak wymagań dotyczących bezpieczeństwa lub danych
Tworzenie zbyt technicznych user stories
Tworzenie roadmapy bez jasno określonych priorytetów
Jak uniknąć błędów
Określ cel API, zanim omówisz implementację.
Uwzględnij perspektywy produktu, inżynierii, architektury i bezpieczeństwa.
Powiąż user stories z wymaganiami technicznymi.
Zmapuj zależności, zanim ustalisz priorytety.
Udokumentuj założenia i nierozwiązane pytania.
Wcześnie zweryfikuj potrzeby dotyczące bezpieczeństwa, uwierzytelniania, danych i wydajności.
Ustal kolejność elementów roadmapy w oparciu o zależności i wartość biznesową.
Funkcje Miro, których możesz użyć
Ramki dla każdego etapu warsztatu
Notatki samoprzylepne na wymagania i otwarte pytania
Diagramy architektury pokazujące relacje między systemami
Tabele do user stories i wymagań technicznych
Tagi do oznaczania priorytetu, zależności i odpowiedzialności
Komentarze do dyskusji inżynierskiej
Kolorowe oznaczanie kategorii wymagań
Łączniki dla przepływów architektonicznych
Kształty roadmapy dla kamieni milowych i wydań
Najczęściej zadawane pytania
P: Kto może skorzystać z tego szablonu?O: Menedżerowie produktu, inżynierowie oprogramowania, architekci, programiści API, zespoły ds. bezpieczeństwa, zespoły integracyjne, liderzy techniczni i wielofunkcyjne zespoły produktowe.
P: Kiedy należy użyć tego szablonu?O: Użyj go przed opracowaniem nowego API, rozszerzeniem istniejącego API, planowaniem integracji lub przeglądem architektury API.
P: Czy szablon zawiera user stories?O: Tak. Jedno z etapów jest poświęcone przekształceniu potrzeb API w user stories przed sfinalizowaniem wymagań technicznych.
P: Jakie rodzaje wymagań technicznych można uchwycić?O: Uwierzytelnianie, autoryzacja, punkty końcowe, formaty danych, integracje, zależności, wydajność, obsługa błędów, monitorowanie oraz powiązane potrzeby techniczne.
P: Czy ten szablon obsługuje API wewnętrzne i zewnętrzne?O: Tak. Można go użyć do usług wewnętrznych, integracji z partnerami, publicznych API i API platformowych.
P: Co uczestnicy otrzymają?O: Udokumentowany cel API, widok wpływu architektonicznego, historyjki użytkownika, wymagania techniczne, zależności oraz priorytetowa roadmapa wdrożenia.
