Czym jest szablon wymagań API?
Szablon do wspólnego planowania API, który pomaga zespołom produktowym, inżynieryjnym i architektonicznym określić potrzeby API przed rozpoczęciem prac deweloperskich. Warsztat przebiega przez pięć etapów: zbieranie informacji o API, analizę wpływu na architekturę, tworzenie user stories, dokumentowanie wymagań technicznych i zależności oraz tworzenie roadmapy dostawy.
Jakie problemy rozwiązuje szablon wymagań API?
Niekompletne wymagania API
Niejasne potrzeby integracyjne
Brak kontekstu architektonicznego
Brak powiązania między potrzebami użytkowników a wymaganiami technicznymi
Ukryte zależności
Słabe zgranie między zespołem produktowym a zespołem inżynieryjnym
Niejasna kolejność implementacji
Jak korzystać z szablonu wymagań API
Rozpocznij od zebrania informacji o API oraz zidentyfikowania interesariuszy, systemów i potrzeb biznesowych.
Przeanalizuj wpływ na architekturę i zmapuj powiązania między systemami, usługami i integracjami.
Utwórz user stories opisujące, czego użytkownicy, systemy lub zespoły wewnętrzne potrzebują od API.
Udokumentuj wymagania techniczne, zależności, potrzeby związane z bezpieczeństwem, kwestie dotyczące danych oraz ograniczenia integracji.
Na koniec uporządkuj wymagania w roadmapę z priorytetami, kamieniami milowymi i kolejnością implementacji.
Typowe pułapki
Rozpoczynanie prac rozwojowych, zanim cel API stanie się jasny
Dokumentowanie punktów końcowych 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 jasnych priorytetów
Jak unikać błędów
Zdefiniuj cel API, zanim omówisz implementację.
Uwzględnij perspektywy produktu, inżynierii, architektury i bezpieczeństwa.
Połącz user stories z wymaganiami technicznymi.
Zmapuj zależności przed ustaleniem priorytetów.
Udokumentuj założenia i otwarte pytania.
Sprawdź na wczesnym etapie potrzeby w zakresie bezpieczeństwa, uwierzytelniania, danych i wydajności.
Ułóż elementy roadmapy w kolejności uwzględniającej zależności i wartość biznesową.
Funkcje Miro, które możesz wykorzystać
Frames na każdy etap warsztatu
Sticky notes na wymagania i otwarte pytania
Architecture diagrams do zobrazowania relacji między systemami
Tabele dla user stories i wymagań technicznych
Tags do oznaczania priorytetu, zależności i właściciela
Komentarze do dyskusji inżynierskiej
Oznaczanie kolorami kategorii wymagań
Łączniki dla przepływów architektonicznych
Kształty mapy drogowej 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, deweloperzy API, zespoły ds. bezpieczeństwa, zespoły integracyjne, liderzy techniczni oraz interdyscyplinarne zespoły produktowe.
P: Kiedy należy użyć tego szablonu?O: Użyj go przed zbudowaniem nowego API, przed rozszerzaniem istniejącego API, przy planowaniu integracji lub podczas przeglądu architektury API.
P: Czy szablon zawiera historie użytkownika?O: Tak. Jeden etap jest poświęcony przekształcaniu potrzeb API w historie użytkownika przed sfinalizowaniem wymagań technicznych.
P: Jakie rodzaje wymagań technicznych można zebrać?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 wewnętrzne i zewnętrzne API?O: Tak. Można go użyć do usług wewnętrznych, integracji z partnerami, publicznych API oraz API platformowych.
P: Co uczestnicy otrzymają?O: Udokumentowany cel API, przegląd wpływu na architekturę, user stories, wymagania techniczne, zależności oraz priorytetowa roadmapa wdrożeniowa.
