Czym jest szablon wymagań API?
Wspólny szablon do planowania API, który pomaga zespołom produktowym, inżynierskim i architektonicznym określić potrzeby API przed rozpoczęciem prac deweloperskich. Warsztat przebiega przez pięć etapów: zebranie informacji o API, analiza wpływu na architekturę, tworzenie user stories, dokumentowanie wymagań technicznych i zależności oraz przygotowanie roadmapy dostawy.
Jakie problemy rozwiązuje szablon wymagań API?
Niekompletne wymagania API
Niejasne wymagania dotyczące integracji
Brak kontekstu architektonicznego
Brak powiązania między potrzebami użytkowników a wymaganiami technicznymi
Ukryte zależności
Słaba koordynacja między zespołem produktowym a zespołem inżynierskim
Niejasna kolejność wdrożeń
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, jak łączą się systemy, usługi i integracje.
Stwórz user stories opisujące, czego użytkownicy, systemy lub zespoły wewnętrzne potrzebują od API.
Udokumentuj wymagania techniczne, zależności, potrzeby w zakresie bezpieczeństwa, kwestie związane z danymi oraz ograniczenia integracji.
Na koniec uporządkuj wymagania w roadmapę z priorytetami, kamieniami milowymi i kolejnością realizacji.
Typowe pułapki
Rozpoczynanie prac przed jasnym określeniem celu API
Dokumentowanie endpointów bez zrozumienia potrzeb użytkowników
Pomijanie analizy wpływu na architekturę
Ignorowanie zależności między systemami
Brak wymagań dotyczących bezpieczeństwa lub danych
Tworzenie user stories, które są zbyt techniczne
Tworzenie roadmapy bez jasnych priorytetów
Sposoby unikania 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 prac.
Udokumentuj założenia i nierozwiązane pytania.
Wcześnie przejrzyj wymagania dotyczące bezpieczeństwa, uwierzytelniania, danych i wydajności.
Ustal kolejność elementów roadmapy zgodnie z zależnościami i wartością biznesową.
Funkcje Miro, których możesz użyć
Ramki dla każdego etapu warsztatu
Notatki samoprzylepne do wymagań i otwartych pytań
Diagramy architektury przedstawiające relacje między systemami
Tabele do user stories i wymagań technicznych
Tagi do oznaczania priorytetu, zależności i właściciela
Komentarze do dyskusji zespołu inżynieryjnego
Kodowanie kolorami 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 oraz wielofunkcyjne zespoły produktowe.
P: Kiedy należy użyć tego szablonu?O: Stosuj go przed stworzeniem nowego API, rozszerzeniem istniejącego API, planowaniem integracji lub przeglądem architektury API.
P: Czy szablon zawiera user stories?O: Tak. Jeden etap jest poświęcony przekształcaniu potrzeb dotyczących API w user stories przed ostatecznym określeniem wymagań technicznych.
P: Jakie rodzaje wymagań technicznych można ująć?O: Uwierzytelnianie, autoryzacja, punkty końcowe, formaty danych, integracje, zależności, wydajność, obsługa błędów, monitoring 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 oraz API platformowych.
P: Co uczestnicy otrzymają?O: Udokumentowany cel API, widok wpływu na architekturę, user stories, wymagania techniczne, zależności oraz roadmapa wdrożeniowa z ustalonymi priorytetami.
