Dobra dokumentacja to różnica między narzędziem, które ludzie tylko testują, a tym, które wdrażają.
Dzisiaj uruchamiamy foura.ai/docs, czyli pełną stronę z dokumentacją platformy FourA.
Co zawiera dokumentacja
Pierwsze kroki
Wszystko, czego potrzebujesz, aby przejść od rejestracji do pierwszego udanego pobrania danych w mniej niż dwie minuty. Szybki start, konfiguracja uwierzytelniania oraz przykłady w Python, Node.js, Go, Ruby i cURL.
API Reference
Kompletna dokumentacja endpointów z parametrami requestów, formatami response, kodami błędów i gotowymi do skopiowania przykładami dla każdej operacji.
Przewodniki
Szczegółowe omówienie pojęć związanych z FourA: jak wybrać odpowiedni typ zadania do swojego use case'u, jak działa ochrona anti-bot oraz jak optymalizować wydajność i koszty.
Tutoriale krok po kroku
Instrukcje krok po kroku dla konkretnych zadań: scraping dynamicznych stron, monitorowanie cen konkurencji i wiele innych, które będziemy dodawać co tydzień.
Rozwiązywanie problemów
Rozwiązania najczęstszych problemów, od pustych response i błędów timeout, po problemy z uwierzytelnianiem i rate limiting.
Stworzone dla deweloperów
Strona z dokumentacją została zaprojektowana z myślą o developer experience:
- Wyszukiwarka pełnotekstowa przeszukująca całą dokumentację
- Nawigacja boczna uporządkowana według tematów
- Spis treści na każdej stronie ułatwiający szybkie przechodzenie do sekcji
- Nawigacja poprzedni/następny do czytania po kolei
- Układ mobile-friendly działający na każdym urządzeniu
Więc tak, na telefonie też działa.
Co dalej
Dokumentacja to żywy produkt. Na podstawie opinii użytkowników co tydzień będziemy dodawać nowe przewodniki i tutoriale. Oto co pojawi się wkrótce:
- Szybki start z SDK dla Python i Node.js
- Dokumentacja webhooków i callbacków
- Zaawansowany przewodnik po konfiguracji proxy
- Przykłady integracji (n8n, Zapier, Make)
Czekamy na feedback
Widzisz literówkę? Brakuje jakiegoś tematu? Daj nam znać na support@foura.ai. Najlepszą dokumentację tworzą ludzie, którzy z niej korzystają (a nie ci, którzy ją piszą), więc nie krępuj się.