Jak łatwo dokumentować swoje integracje za pomocą Notion

Wraz z rozwojem rynku automatyzacji przepływu pracy pojawiają się nowe możliwości i sytuacje.

Wśród nich jest proces dokumentowania integracji i automatyzacji, którym wiele (jeśli nie większość) firm będzie musiało się zająć w najbliższej przyszłości.

Każdy, kto zagłębił się w narzędzia takie jak Integromat, wie, że zbudowanie jednej automatyzacji często prowadzi do zbudowania wielu innych, a oto, gdzie pojawia się główny problem:

Jak organizujecie i dokumentujecie integracje?

Znalezienie nowych sposobów na poprawę wydajności i zautomatyzowanie żmudnych zadań to świetna sprawa. Jednak wraz ze wzrostem liczby integracji całkiem normalne jest, że traci się je z oczu i wie, co robi każda z nich.

W tej linii ważne jest, aby wdrożyć i utrzymywać system dokumentacji dla rozszerzającego się portfolio automatyki.

Jest to szczególnie istotne w przypadku firm, które intensywnie automatyzują , ale także dla agencji i firm konsultingowych zajmujących się technologiami, które tworzą integracje dla wielu klientów.

Jaki jest więc najlepszy sposób na udokumentowanie integracji?

Aby uzyskać odpowiedzi i przykłady z życia wzięte, zapytaliśmy certyfikowanego partnera Integromat, firmę XRay.Tech, o to, jak zarządzają dokumentacją dla swoich klientów i dla siebie.

Rzućmy okiem na to, co nam udostępnili.

Odskocznia do automatyzacji na dużą skalę

XRay.Tech to firma zajmująca się doradztwem w zakresie automatyzacji z siedzibą w East Haven w stanie Connecticut. Obecnie zarządzają setkami zautomatyzowanych przepływów pracy dla swoich klientów, a także kontrolują własne operacje wewnętrzne.

Aby to zrobić, stworzyli metodę dokumentacji, która ułatwia śledzenie każdej opracowanej przez nich integracji aplikacji, dotykając również wydajności przepływu pracy.

Kluczowym elementem jest wschodząca gwiazda w świecie aplikacji: Notion .

Jeśli budujesz integracje dla swojej firmy lub dla klientów, zachęcamy do śledzenia i skonfigurowania podobnego systemu dla siebie.

Koleś, gdzie moja integracja?

Dokładna dokumentacja jest tak samo ważna w światach automatyzacji z niskim kodem i bez kodu, jak w przypadku tradycyjnego tworzenia oprogramowania.

Zasadniczo główny cel dokumentowania integracji jest taki sam, jak dokumentowanie kodu: chcesz mieć pewność, że Twoi współpracownicy rozumieją Twoją pracę i przyczyniają się do niej bez dodatkowych problemów .

Wybranym narzędziem XRay do osiągnięcia tego celu jest Notion.

Chociaż możesz używać innych aplikacji do dokumentacji, XRay opiera się na wszechstronnych funkcjach Notion, aby zarządzać obszernym zbiorem informacji.

Na przykład Notion pozwala dodawać niestandardowe atrybuty do dowolnego dokumentu, aby pomóc w sortowaniu i porządkowaniu wszystkich informacji. Możesz dodać osoby do dokumentu, aby:

  • Wyjaśnij, kto powinien się do tego przyczynić
  • Powiąż go z klientem, projektem lub zadaniami
  • Dołącz pomocne linki i pliki, aby nadać dalszy kontekst

To powiedziawszy, możesz również zastosować ogólne zasady tej metody dokumentacji do dowolnej aplikacji do robienia notatek lub edytora tekstu, ale poniższe przykłady opierają się na Notion.

Przyjrzyjmy się im.

Dokumentowanie integracji: Pierwsze kroki

Proces dokumentacji XRay rozpoczyna się od krótkiego, ale opisowego podsumowania tego, co robi i jak działa zautomatyzowany przepływ pracy.

Dobrą wskazówką, aby zachować spójność na tym etapie, jest wyobrażenie sobie, że ktoś, kto nigdy nie widział tych integracji, będzie czytał dokumentację, aby się o nich dowiedzieć .

Mając to na uwadze, upewnij się, że zawierasz wystarczającą ilość informacji, aby czytelnik mógł zrozumieć cel przepływu pracy, a także każde z zadań, które go tworzą.

XRay zazwyczaj tworzy stronę Notion dla każdego procesu, która z kolei może zawierać kilka przepływów pracy, które przyczyniają się do jego funkcjonowania i realizacji.

W zależności od ilości i złożoności przepływów zaangażowanych w dany proces, można również tworzyć podstrony dla każdego przepływu (punkt za możliwości zagnieżdżania stron w Notion).

Aby zachować jednolitość zapisów, stosowany jest szablon dokumentacji, który wstępnie wypełnia każdą stronę Notion kilkoma podpowiedziami.

Na poniższym zrzucie ekranu możesz zobaczyć, jak wygląda pusty, nowo utworzony szablon.

notion-documentation-page-example-alt

Jak widać, szablon zawiera predefiniowane pytania o to, kiedy i dlaczego używana jest automatyzacja. Są one kluczowe w wyjaśnieniu jego przypadku użycia.

Z drugiej strony pytania dotyczące zaangażowanych danych pomagają określić techniczną konfigurację przepływu pracy i zaangażowane w niego aplikacje.

automation-documentation-example-alt

Dołączone są również zrzuty ekranu przepływów pracy. Jest to wygodny sposób na wizualizację integracji bez konieczności tworzenia nowej grafiki od podstaw.

Dalej: Dodawanie atrybutów w celu uporządkowania dokumentacji

Notion pozwala na dodawanie różnorodnych atrybutów do każdej strony i to jest jeden z powodów, dla których jest tak doskonałym narzędziem do wewnętrznej dokumentacji.

Możesz na przykład utworzyć notatki o statusie dla każdego przepływu pracy, zdefiniować jego typ, dodać łącze do Integromatu (gdzie hostowane są automatyzacje), wyświetlić listę współautorów i połączyć stronę z profilem klienta (lub oznaczyć ją jako automatyzację wewnętrzną) . Zobacz przykład poniżej w celach informacyjnych:

notion-documentation-example-2-alt

Następnie możesz użyć widoków Notion, aby posortować dane na podstawie wyżej wymienionych atrybutów.

Umożliwi to przeglądanie i analizowanie wszystkich przepływów pracy na jednym ekranie. Na przykład będziesz mógł zobaczyć, które z nich zostały stworzone do użytku wewnętrznego, te, które są w budowie, lub połączyć inne kryteria, aby uzyskać dokładne wyczucie statusu, celu i typu przepływu pracy.

documenting-automation-database-alt

W przypadku XRay te elastyczne atrybuty i widoki pomagają pracownikom znaleźć interesujące ich integracje i szybko przestudiować wszystkie dostępne informacje.

Warto zauważyć, że są to wszystkie atrybuty niestandardowe i można je w ciągu kilku minut zmienić w celu dostosowania do potrzeb organizacji.

Wniosek

Kiedy zaczynasz z automatyzacją, nie jest zbyt trudno mieć oko na scenariusze Integromatu, ale ta sytuacja może się zmieniać wraz z upływem czasu.

Dla firm zajmujących się rosnącą liczbą integracji kluczowe stanie się posiadanie systemu wyjaśniania innym, co robią.

Wczesne wdrożenie systemu dokumentacji ułatwi automatyzację na dużą skalę, utrzymując wszystkich na tej samej stronie; ponadto jest to dobry sposób na uniknięcie przerażających silosów informacyjnych.

Głównym celem jest kontrolowanie sposobu dokumentowania integracji i automatyzacji.

Jak pokazali nam nasi przyjaciele z XRay Tech, stworzenie prostego, informacyjnego systemu pozwoli w ciągu kilku sekund odtworzyć przydatne przepływy pracy i uniknąć wszelkiego rodzaju zbędnych czynności.

Podobnie jak w przypadku samej automatyzacji, większa wydajność czeka z jej dokumentacją.

Miłej automatyzacji!