Tworząc narzędzie Sidekick dla swojej aplikacji, pamiętaj o tych najlepszych praktykach.

Używaj nazw zamiast identyfikatorów

Użytkownicy posługują się nazwami, a nie liczbami. Poproszą o „dodanie elementu do tablicy Marketing”, a nie o „utworzenie elementu na tablicy 456”. Twoje narzędzie powinno rozpoznawać nazwy i samodzielnie wyszukiwać odpowiadające im identyfikatory.

Jeśli nie uda się znaleźć nazwy, poproś o doprecyzowanie:

„Nie udało mi się znaleźć tablicy o nazwie „Plan marketingowy”. Czy mam sprawdzić, czy są podobne tablice?”

Dzięki obsłudze języka naturalnego korzystanie z narzędzia przypomina rozmowę i jest intuicyjne, co ułatwia każdą interakcję.

Używaj terminologii monday.com

Sidekick rozumie już podstawowe obiekty monday.com - tablice, elementy, dokumenty WorkDoc, aktualizacje i właścicieli. Używaj tych samych określeń w danych wejściowych, opisach i odpowiedziach.

Spójna terminologia pomaga Sidekickowi poprawnie interpretować polecenia i sprawia, że narzędzie jest znajome dla użytkowników. Im bardziej Twoje słownictwo odpowiada terminologii monday.com, tym bardziej naturalnie będzie brzmieć Twoje narzędzie i tym łatwiej Sidekickowi będzie rozpoznać, kiedy go użyć.

Używaj w narzędziach tylko bloków akcji działających w czasie rzeczywistym

Sidekick może używać tylko bloków automatyzacji, które uruchamiają się od razu i zwracają wyniki w ciągu kilku sekund. Bloków, które wymagają oczekiwania, działają asynchronicznie, są zaplanowane lub korzystają z zewnętrznych wyzwalaczy, nie można używać jako narzędzi.

Aby upewnić się, że blok jest zgodny, musi:

• Wykonywać całą logikę w kroku execute
• Zwracać wyniki synchronicznie
• Nie czekać na zewnętrzne aktualizacje ani wywołania zwrotne
• Działać niezawodnie w krótkim czasie
• Zawsze zwracać te same dane wyjściowe w tej samej strukturze dla tych samych danych wejściowych

Zamieniaj błędy we wskazówki

Błąd nie powinien przerywać działania - powinien pomagać użytkownikom przejść dalej. Zamiast wyświetlać techniczne komunikaty lub po cichu przerywać działanie, podpowiedz użytkownikom, co mogą zrobić.

Jeśli brakuje wymaganego parametru, wyjaśnij, jakie informacje są potrzebne, albo zadaj pytanie doprecyzowujące. Tak przebiega naturalna rozmowa: gdy czegoś nie rozumiemy, prosimy o dodatkowe informacje, zamiast ją kończyć.

Jeśli brakuje wymaganego parametru, wyjaśnij, jakie informacje są potrzebne, albo zadaj pytanie doprecyzowujące. Często problemem jest niejasna intencja, a nie brak pola - zwykle wystarczy jedno konkretne pytanie. Jeśli zadbasz o możliwość odzyskania kontroli po błędzie, Twoje narzędzie wzbudzi zaufanie i pozwoli użytkownikom sprawnie kontynuować pracę.

Proś o zatwierdzenie w przypadku wrażliwych działań

Niektóre działania wymagają zatrzymania się przed wykonaniem - na przykład wysyłanie wiadomości e-mail, publikowanie treści czy modyfikowanie danych. Poproś narzędzie o podsumowanie planowanego działania i przedstawienie jego podglądu do sprawdzenia:

„Oto wersja robocza wiadomości e-mail do Acme Corp. Zatwierdź ją przed wysłaniem”.

Prośba o potwierdzenie daje użytkownikom pewność, że Sidekick nie podejmie działania na podstawie niepełnych informacji. To proste zabezpieczenie z udziałem człowieka sprawia, że narzędzie pozostaje funkcjonalne, a jednocześnie działa w przewidywalny sposób. Jest niezbędne w przypadku działań, których nie da się cofnąć.

Potwierdzaj wykonanie każdego działania

Gdy Sidekick wykona działanie za pomocą Twojego narzędzia, zawsze wyraźnie potwierdź, że się powiodło. Wyświetl krótką wiadomość o powodzeniu i, jeśli to możliwe, podaj link do miejsca, w którym użytkownik może sprawdzić wynik - na przykład do utworzonego przez aplikację rekordu, wpisu lub dokumentu.

„Twój wpis z kampanią został opublikowany. Zobacz go na LinkedIn. [link]”

Ten prosty komunikat buduje zaufanie i domyka proces - łączy intencję z wynikiem. Pomaga użytkownikom mieć pewność, że ich prośba została zrealizowana, i ułatwia im dalsze działania.

Jeśli to możliwe, umożliwiaj cofanie działań

Jeśli to możliwe, dodaj działanie odwrotne - na przykład usuwanie, przywracanie poprzedniego stanu lub cofanie. Nawet jeśli Sidekick nie udostępnia jeszcze dedykowanej funkcji cofania, takie podejście sprawi, że Twoje narzędzie będzie gotowe na przyszłe zmiany i zwiększy pewność użytkowników.

Użytkownicy chętniej wypróbowują nowe funkcje, gdy wiedzą, że mogą bezpiecznie cofnąć działanie.

Usprawniaj przebieg rozmowy

Najlepsze narzędzia Sidekick wykonują zadania w jak najmniejszej liczbie kroków. Sprawnie obsługuj niepełne informacje, bezpiecznie uzupełniaj kontekst i unikaj zbędnych pytań doprecyzowujących. Gdy intencja jest niejasna, zadaj jedno lub dwa konkretne pytania, a potem wykonaj działanie.
Gdy intencja jest jasna, nie proś użytkowników o ponowne podawanie informacji - zinterpretuj ich prośbę i przejdź dalej, pamiętając o uzyskaniu zatwierdzenia, gdy jest to konieczne.

Przykład: jeśli użytkownik powie „Dodaj to zadanie do głównej tablicy projektu”, na podstawie bieżącego kontekstu ustal, o którą tablicę chodzi, zamiast ponownie o to pytać.

Sprawna obsługa świadczy o inteligencji narzędzia. Krótka wymiana wiadomości sprawia wrażenie płynnej współpracy - jakby Sidekick i Twoja aplikacja wspólnie dążyły do celu.

Pisz jasne opisy narzędzi Sidekick

Tytuł i opis narzędzia Sidekick to przewodnik dla Sidekicka. Informują system, kiedy i jak korzystać z danej funkcji. Pisz tak, jakbyś objaśniał narzędzie nowej osobie w zespole:

Co robi
Kiedy należy go używać
Jakich danych wejściowych oczekuje
Jakie dane zwraca

Każdy blok automatyzacji powinien mieć tytuł, opis i metadane określające jego cel, oczekiwane dane wejściowe, ograniczenia i dane wyjściowe. Na przykład: „Tworzy nowy element na tablicy monday.com, gdy użytkownicy proszą o dodanie zadania lub rezultatu pracy. Dane wejściowe: nazwa tablicy (wymagane), nazwa elementu (wymagane), właściciel (opcjonalnie). Zwraca: link do utworzonego elementu”.

Zwięzłe, przemyślane opisy ograniczają niejednoznaczność i pomagają Sidekickowi trafniej dopasowywać prośby do Twojego narzędzia.

Wskazuj źródło danych

Jeśli Twoje narzędzie pobiera dane spoza monday.com, wyraźnie wskaż ich źródło. Jeśli to istotne, podaj też datę lub godzinę, aby pokazać, jak aktualne są informacje.

„Według Salesforce (aktualizacja sprzed 2 godzin) ta szansa sprzedażowa jest na etapie oferty”.

Podawanie źródeł zmienia dane wyjściowe narzędzia z nieprzejrzystych danych w możliwe do zweryfikowania informacje. To drobny szczegół, który znacząco zwiększa wiarygodność.

Odpowiadaj zwięźle i na temat

Zwracaj tylko te informacje, które będą przydatne w kolejnym kroku. Nie przytłaczaj użytkowników surowymi danymi, identyfikatorami ani metadanymi, chyba że są potrzebne do dalszych działań.

Zwięzła, konkretna odpowiedź pozwala Sidekickowi i użytkownikowi szybko przejść do działania. W razie potrzeby połącz krótkie podsumowanie napisane przystępnym językiem z danymi w uporządkowanej formie. Krótko mówiąc: mniej szumu, więcej konkretów.

Dokumentuj dokładnie swoje narzędzie Sidekick

Dokumentacja jest częścią produktu. Opisy, parametry i przykłady pomagają Sidekickowi oraz innym programistom zrozumieć, co robi Twoje narzędzie.

Pisz jasno, dodawaj przykładowe polecenia i wyjaśniaj, jak narzędzie zachowuje się w różnych kontekstach. Przygotuj przykłady poleceń dla typowych sytuacji, przypadków brzegowych i błędów - możesz je potem przetestować. Im lepiej opiszesz działanie narzędzia, tym bardziej niezawodnie Sidekick będzie mógł je wykorzystać.